edu.duke.cs.banjo.data.settings
Class MandatorySettingItem

java.lang.Object
  extended byedu.duke.cs.banjo.data.settings.SettingItem
      extended byedu.duke.cs.banjo.data.settings.MandatorySettingItem

public class MandatorySettingItem
extends SettingItem

Holds an individual setting that is loaded into Banjo.

Details:

Change History:
Created on Oct 19, 2005
Part of a large-scale refactoring of the settings processing.

hjs (v2.1) Add constructor based on existing settingItem

Author:
Jurgen Sladeczek (hjs)
For the latest info, please visit www.cs.duke.edu.

Nested Class Summary
 
Nested classes inherited from class edu.duke.cs.banjo.data.settings.SettingItem
SettingItem.DataTypeValidator, SettingItem.DiscretizationExceptionsValidator, SettingItem.DiscretizationPolicyValidator, SettingItem.DoubleValidator, SettingItem.FileValidator, SettingItem.IntegerListValidator, SettingItem.IntegerValidator, SettingItem.LongValidator, SettingItem.PathValidator, SettingItem.StringValidator, SettingItem.TimeStampValidator, SettingItem.TimeValidator, SettingItem.Validator
 
Field Summary
 
Fields inherited from class edu.duke.cs.banjo.data.settings.SettingItem
collectedErrors, isDefaultValueUsed, isValidSetting, itemNameCanonical, itemNameDescriptive, itemNameForComparison, itemNameForDisplay, itemNameFormattedForDisplay, itemValueAsLoaded, itemValueValidated, objItemInfo, objItemValue
 
Constructor Summary
MandatorySettingItem(SettingItem _settingItem)
          Constructor based on an existing settingItem.
MandatorySettingItem(java.lang.String _itemNameCanonical, java.lang.String _itemNameDescriptive, java.lang.String _settingNameForDisplay)
          Constructor for creating a new "mandatory" settingItem.
 
Method Summary
 boolean validate(java.lang.String _itemValueAsLoaded, java.lang.String _dataTypeToValidateAgainst, int _validationType, java.lang.Object _additionalInfo, java.lang.Object _defaultValue)
          Validation of a "mandatory" setting item.
 
Methods inherited from class edu.duke.cs.banjo.data.settings.SettingItem
equals, errorMessageInvalidFilePath, errorMessageMissingValue, errorMessageWrongDataType, errorMessageWrongTimeFormat, formatForDisplay, getCollectedErrors, getErrorMessages, getItemNameCanonical, getItemNameDescriptive, getItemNameForComparison, getItemNameFormattedForDisplay, getItemValueAsLoaded, getItemValueValidated, getObjItemInfo, getObjItemValue, isDefaultValueUsed, isValidSetting, setDefaultValueUsed, setItemNameFormattedForDisplay, setItemValueAsLoaded, setItemValueValidated, setObjItemInfo, setObjItemValue, setValidSetting, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MandatorySettingItem

public MandatorySettingItem(java.lang.String _itemNameCanonical,
                            java.lang.String _itemNameDescriptive,
                            java.lang.String _settingNameForDisplay)
                     throws java.lang.Exception
Constructor for creating a new "mandatory" settingItem.

Parameters:
_itemNameCanonical - The unique name that we use to refer to the settingItem.
_itemNameDescriptive - The descriptive name of the settingItem.
_settingNameForDisplay - The special name of the settingItem used in user feedback.

MandatorySettingItem

public MandatorySettingItem(SettingItem _settingItem)
Constructor based on an existing settingItem. Note that the invoked super class constructor does a "deep" copy.

Parameters:
_settingItem - The settingItem that we want to use as basis for the new one.
Method Detail

validate

public boolean validate(java.lang.String _itemValueAsLoaded,
                        java.lang.String _dataTypeToValidateAgainst,
                        int _validationType,
                        java.lang.Object _additionalInfo,
                        java.lang.Object _defaultValue)
                 throws java.lang.Exception
Validation of a "mandatory" setting item.

Overrides:
validate in class SettingItem
Throws:
java.lang.Exception