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

java.lang.Object
  extended byedu.duke.cs.banjo.data.settings.SettingItem
Direct Known Subclasses:
MandatorySettingItem, OptionalSettingItem

public abstract class SettingItem
extends java.lang.Object

Holds an individual setting that is loaded into Banjo.

Details:

Change History:
Created on Nov 4, 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
protected  class SettingItem.DataTypeValidator
           
protected  class SettingItem.DiscretizationExceptionsValidator
           
protected  class SettingItem.DiscretizationPolicyValidator
           
protected  class SettingItem.DoubleValidator
           
protected  class SettingItem.FileValidator
           
protected  class SettingItem.IntegerListValidator
           
protected  class SettingItem.IntegerValidator
           
protected  class SettingItem.LongValidator
           
protected  class SettingItem.PathValidator
           
protected  class SettingItem.StringValidator
           
protected  class SettingItem.TimeStampValidator
           
protected  class SettingItem.TimeValidator
           
protected  class SettingItem.Validator
           
 
Field Summary
protected  java.util.Set collectedErrors
           
protected  boolean isDefaultValueUsed
           
protected  boolean isValidSetting
           
protected  java.lang.String itemNameCanonical
           
protected  java.lang.String itemNameDescriptive
           
protected  java.lang.String itemNameForComparison
           
protected  java.lang.String itemNameForDisplay
           
protected  java.lang.String itemNameFormattedForDisplay
           
protected  java.lang.String itemValueAsLoaded
           
protected  java.lang.String itemValueValidated
           
protected  java.lang.Object objItemInfo
           
protected  java.lang.Object objItemValue
           
 
Constructor Summary
SettingItem(SettingItem _settingItem)
          Constructor based on an existing settingItem.
SettingItem(java.lang.String _itemNameCanonical, java.lang.String _itemNameDescriptive, java.lang.String _itemNameForDisplay)
           
 
Method Summary
 boolean equals(java.lang.Object otherObj)
           
protected  java.lang.String errorMessageInvalidFilePath(java.lang.String _itemNameDescriptive, java.lang.String _itemNameCanonical, java.lang.String _itemValue, java.lang.String _dataTypeToValidateAgainst)
           
protected  java.lang.String errorMessageMissingValue(java.lang.String _itemNameDescriptive, java.lang.String _itemNameCanonical, java.lang.String _itemValue, java.lang.String _dataTypeToValidateAgainst)
           
protected  java.lang.String errorMessageWrongDataType(java.lang.String _itemNameDescriptive, java.lang.String _itemNameCanonical, java.lang.String _itemValue, java.lang.String _dataTypeToValidateAgainst)
           
protected  java.lang.String errorMessageWrongTimeFormat(java.lang.String _itemNameDescriptive, java.lang.String _itemNameCanonical, java.lang.String _itemValue, java.lang.String _dataTypeToValidateAgainst)
           
protected  java.lang.String formatForDisplay(java.lang.String textToFormat)
           
 java.util.Set getCollectedErrors()
           
 java.lang.String getErrorMessages()
           
 java.lang.String getItemNameCanonical()
           
 java.lang.String getItemNameDescriptive()
           
 java.lang.String getItemNameForComparison()
           
 java.lang.String getItemNameFormattedForDisplay()
           
 java.lang.String getItemValueAsLoaded()
           
 java.lang.String getItemValueValidated()
           
 java.lang.Object getObjItemInfo()
           
 java.lang.Object getObjItemValue()
           
 boolean isDefaultValueUsed()
           
 boolean isValidSetting()
           
 void setDefaultValueUsed(boolean isDefaultValueUsed)
           
protected  void setItemNameFormattedForDisplay(java.lang.String itemNameFormattedForDisplay)
           
protected  void setItemValueAsLoaded(java.lang.String _itemValueAsLoaded)
           
 void setItemValueValidated(java.lang.String itemValueValidated)
           
 void setObjItemInfo(java.lang.Object _itemInfo)
           
protected  void setObjItemValue(java.lang.Object objItemValue)
           
protected  void setValidSetting(boolean isValidSetting)
           
 java.lang.String toString()
           
protected  boolean validate(java.lang.String _itemValueToValidate, java.lang.String dataTypeToValidateAgainst, int validationType, java.lang.Object _additionalInfo, java.lang.Object _defaultValue)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

itemNameCanonical

protected final java.lang.String itemNameCanonical

itemNameForComparison

protected final java.lang.String itemNameForComparison

itemNameDescriptive

protected final java.lang.String itemNameDescriptive

itemNameForDisplay

protected final java.lang.String itemNameForDisplay

itemNameFormattedForDisplay

protected java.lang.String itemNameFormattedForDisplay

itemValueAsLoaded

protected java.lang.String itemValueAsLoaded

itemValueValidated

protected java.lang.String itemValueValidated

objItemValue

protected java.lang.Object objItemValue

objItemInfo

protected java.lang.Object objItemInfo

isValidSetting

protected boolean isValidSetting

isDefaultValueUsed

protected boolean isDefaultValueUsed

collectedErrors

protected java.util.Set collectedErrors
Constructor Detail

SettingItem

public SettingItem(java.lang.String _itemNameCanonical,
                   java.lang.String _itemNameDescriptive,
                   java.lang.String _itemNameForDisplay)
            throws java.lang.Exception

SettingItem

public SettingItem(SettingItem _settingItem)
Constructor based on an existing settingItem.

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

validate

protected boolean validate(java.lang.String _itemValueToValidate,
                           java.lang.String dataTypeToValidateAgainst,
                           int validationType,
                           java.lang.Object _additionalInfo,
                           java.lang.Object _defaultValue)
                    throws java.lang.Exception
Throws:
java.lang.Exception

equals

public boolean equals(java.lang.Object otherObj)

getErrorMessages

public java.lang.String getErrorMessages()

formatForDisplay

protected java.lang.String formatForDisplay(java.lang.String textToFormat)

errorMessageWrongDataType

protected java.lang.String errorMessageWrongDataType(java.lang.String _itemNameDescriptive,
                                                     java.lang.String _itemNameCanonical,
                                                     java.lang.String _itemValue,
                                                     java.lang.String _dataTypeToValidateAgainst)

errorMessageInvalidFilePath

protected java.lang.String errorMessageInvalidFilePath(java.lang.String _itemNameDescriptive,
                                                       java.lang.String _itemNameCanonical,
                                                       java.lang.String _itemValue,
                                                       java.lang.String _dataTypeToValidateAgainst)

errorMessageMissingValue

protected java.lang.String errorMessageMissingValue(java.lang.String _itemNameDescriptive,
                                                    java.lang.String _itemNameCanonical,
                                                    java.lang.String _itemValue,
                                                    java.lang.String _dataTypeToValidateAgainst)

errorMessageWrongTimeFormat

protected java.lang.String errorMessageWrongTimeFormat(java.lang.String _itemNameDescriptive,
                                                       java.lang.String _itemNameCanonical,
                                                       java.lang.String _itemValue,
                                                       java.lang.String _dataTypeToValidateAgainst)

getItemNameForComparison

public java.lang.String getItemNameForComparison()
Returns:
Returns the itemNameForComparison.

getItemNameCanonical

public java.lang.String getItemNameCanonical()
Returns:
Returns the itemNameCanonical.

getItemNameDescriptive

public java.lang.String getItemNameDescriptive()
Returns:
Returns the itemNameDescriptive.

setItemNameFormattedForDisplay

protected void setItemNameFormattedForDisplay(java.lang.String itemNameFormattedForDisplay)
Parameters:
itemNameFormattedForDisplay - The itemNameFormattedForDisplay to set.

getItemNameFormattedForDisplay

public java.lang.String getItemNameFormattedForDisplay()
Returns:
Returns the itemNameFormattedForDisplay.

setItemValueAsLoaded

protected void setItemValueAsLoaded(java.lang.String _itemValueAsLoaded)
Parameters:
_itemValueAsLoaded - The itemValueAsLoaded to set.

getItemValueAsLoaded

public java.lang.String getItemValueAsLoaded()
Returns:
Returns the itemValueAsLoaded.

setItemValueValidated

public void setItemValueValidated(java.lang.String itemValueValidated)
Parameters:
itemValueValidated - The itemValueValidated to set.

getItemValueValidated

public java.lang.String getItemValueValidated()
Returns:
Returns the itemValueValidated.

setObjItemValue

protected void setObjItemValue(java.lang.Object objItemValue)
Parameters:
objItemValue - The objItemValue to set.

getObjItemValue

public java.lang.Object getObjItemValue()
Returns:
Returns the objItemValue.

setValidSetting

protected void setValidSetting(boolean isValidSetting)
Parameters:
isValidSetting - The isValidSetting to set.

isValidSetting

public boolean isValidSetting()
Returns:
Returns the isValidSetting.

getObjItemInfo

public java.lang.Object getObjItemInfo()
Returns:
Returns the objItemInfo.

setObjItemInfo

public void setObjItemInfo(java.lang.Object _itemInfo)
Parameters:
_itemInfo - The objItemInfo to set.

getCollectedErrors

public java.util.Set getCollectedErrors()
Returns:
Returns the collectedErrors.

isDefaultValueUsed

public boolean isDefaultValueUsed()
Returns:
Returns the isDefaultValueUsed.

setDefaultValueUsed

public void setDefaultValueUsed(boolean isDefaultValueUsed)
Parameters:
isDefaultValueUsed - The isDefaultValueUsed to set.

toString

public java.lang.String toString()