com.ibm.ccd.ui.dataobjects.attributes
Class Attribute

java.lang.Object
  extended by com.ibm.ccd.ui.dataobjects.attributes.Attribute
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
BinaryAttribute, GroupAttribute, IntegerAttribute, LookupTableAttribute, NumberAttribute, PeriodAttribute, RelationshipAttribute, StringAttribute, UnSupportedAttribute, URLAttribute

public abstract class Attribute
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Represents the base attribute class for the WPC data types which contain the metadata info like type, constraints and values The attribute values are saved in the valueList irrespective of the data types

See Also:
Serialized Form

Field Summary
protected  int currOccurrence
           
protected  java.lang.String displayLabelName
           
protected  boolean editable
           
protected  java.util.HashMap errorMap
           
protected  java.lang.String hashName
           
protected  boolean isCategorySpecificAttribute
           
protected  boolean isLocalized
           
protected  boolean isPrimaryKey
           
protected  java.util.ArrayList localizedValues
           
protected  int maximumLength
           
protected  int maximumOccurrence
           
protected  int minimumLength
           
protected  int minimumOccurrence
           
protected  Attribute parentAttribute
           
protected  java.lang.String parentPath
           
protected  java.util.ArrayList valueList
           
 
Constructor Summary
Attribute(java.lang.String name, boolean editable, int minimumLength, int maximumLength, int minimumOccurrence, int maximumOccurrence, java.lang.String displayName)
           
Attribute(java.lang.String name, boolean editable, int minimumOccurrence, int maximumOccurrence, java.lang.String displayName)
           
 
Method Summary
 java.lang.String getAttributeParentPath()
           
 int getCurrentOccurrence()
           
 int getCurrOccurrence()
           
 java.lang.String getDisplayLabelName()
           
 java.lang.String getHashName()
           
 java.lang.String getLocaleName()
           
 java.util.ArrayList getLocalizedValues()
           
 int getMaximumLength()
           
 int getMaximumOccurrence()
           
 int getMinimumLength()
           
 int getMinimumOccurrence()
           
 java.lang.String getName()
           
 Attribute getParentGroup()
           
 java.lang.String getParentPath()
           
 java.lang.String getPath()
           
abstract  int getType()
           
 java.lang.String getValidationError(java.lang.String id)
           
 java.util.ArrayList getValueList()
           
 boolean hasAnyParentGroupMultivalued()
           
 boolean isCategorySpecificAttribute()
           
 boolean isEditable()
           
 boolean isLocalized()
           
 boolean isMultiValued()
           
 boolean isOptional()
          when minOccurrence of an attribute is equals 0 return true otherwise false
 boolean isPrimaryKey()
           
 boolean isSubAttribute()
           
 boolean isValueChanged()
           
protected  java.lang.String prepareAttributeParentPath()
           
 void printMe()
           
 void removeValue(int occurrence)
           
 void removeValues()
           
 void setAsLocalized(boolean isLocalized)
           
 void setCategorySpecificAttribute(boolean categorySpecificAttrib)
           
 void setCurrOccurrence(int i)
           
 void setDisplayLabelName(java.lang.String displayLabelName)
           
 void setEditable(boolean editable)
           
 void setHashName(java.lang.String string)
           
 void setLocaleName(java.lang.String localeName)
           
 void setLocalizedValues(java.util.ArrayList localizedValues)
           
 void setMaximumLength(int maximumLength)
           
 void setMaximumOccrrence(int maximumOccurrence)
           
 void setMinimumLength(int minimumLength)
           
 void setMinimumOccrrence(int minimumOccurrence)
           
 void setName(java.lang.String name)
           
 void setParentGroup(Attribute parentAttribute)
           
 void setParentGroupFlagValueChanged()
           
 void setParentPath(java.lang.String string)
           
 void setPath(java.lang.String string)
           
 void setPrimaryKey(boolean primaryKey)
           
 void setSubAttribute(boolean subAttribute)
           
 void setValidationError(java.lang.String id, java.lang.String error)
           
 void setValueChanged(boolean b)
           
 void setValueList(java.util.ArrayList valueList)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

minimumOccurrence

protected int minimumOccurrence

maximumOccurrence

protected int maximumOccurrence

currOccurrence

protected int currOccurrence

minimumLength

protected int minimumLength

maximumLength

protected int maximumLength

editable

protected boolean editable

valueList

protected java.util.ArrayList valueList

isPrimaryKey

protected boolean isPrimaryKey

isCategorySpecificAttribute

protected boolean isCategorySpecificAttribute

displayLabelName

protected java.lang.String displayLabelName

isLocalized

protected boolean isLocalized

localizedValues

protected java.util.ArrayList localizedValues

parentAttribute

protected Attribute parentAttribute

parentPath

protected java.lang.String parentPath

hashName

protected java.lang.String hashName

errorMap

protected java.util.HashMap errorMap
Constructor Detail

Attribute

public Attribute(java.lang.String name,
                 boolean editable,
                 int minimumOccurrence,
                 int maximumOccurrence,
                 java.lang.String displayName)

Attribute

public Attribute(java.lang.String name,
                 boolean editable,
                 int minimumLength,
                 int maximumLength,
                 int minimumOccurrence,
                 int maximumOccurrence,
                 java.lang.String displayName)
Method Detail

isEditable

public boolean isEditable()

getMaximumLength

public int getMaximumLength()

getMaximumOccurrence

public int getMaximumOccurrence()

getMinimumLength

public int getMinimumLength()

getMinimumOccurrence

public int getMinimumOccurrence()

getName

public java.lang.String getName()

setEditable

public void setEditable(boolean editable)

setMaximumLength

public void setMaximumLength(int maximumLength)

setMaximumOccrrence

public void setMaximumOccrrence(int maximumOccurrence)

setMinimumLength

public void setMinimumLength(int minimumLength)

setMinimumOccrrence

public void setMinimumOccrrence(int minimumOccurrence)

setName

public void setName(java.lang.String name)

isMultiValued

public boolean isMultiValued()

getCurrentOccurrence

public int getCurrentOccurrence()

getType

public abstract int getType()

getValueList

public java.util.ArrayList getValueList()

setValueList

public void setValueList(java.util.ArrayList valueList)

isSubAttribute

public boolean isSubAttribute()

setSubAttribute

public void setSubAttribute(boolean subAttribute)

removeValues

public void removeValues()

removeValue

public void removeValue(int occurrence)

isPrimaryKey

public boolean isPrimaryKey()
Returns:
primaryKey

isOptional

public boolean isOptional()
when minOccurrence of an attribute is equals 0 return true otherwise false

Returns:
boolean

setPrimaryKey

public void setPrimaryKey(boolean primaryKey)
Parameters:
primaryKey -

isCategorySpecificAttribute

public boolean isCategorySpecificAttribute()
Returns:
categorySpecificAttrib

setCategorySpecificAttribute

public void setCategorySpecificAttribute(boolean categorySpecificAttrib)
Parameters:
categorySpecificAttrib -

printMe

public void printMe()

getCurrOccurrence

public int getCurrOccurrence()
Returns:
integer

setCurrOccurrence

public void setCurrOccurrence(int i)
Parameters:
i -

getPath

public java.lang.String getPath()
Returns:
string

setPath

public void setPath(java.lang.String string)
Parameters:
string -

getDisplayLabelName

public java.lang.String getDisplayLabelName()
Returns:
Returns the displayLabelName.

setDisplayLabelName

public void setDisplayLabelName(java.lang.String displayLabelName)
Parameters:
displayLabelName - The displayLabelName to set.

setAsLocalized

public void setAsLocalized(boolean isLocalized)

isLocalized

public boolean isLocalized()

getLocalizedValues

public java.util.ArrayList getLocalizedValues()
Returns:
Returns the localizedValues.

setLocalizedValues

public void setLocalizedValues(java.util.ArrayList localizedValues)
Parameters:
localizedValues - The localizedValues to set.

getLocaleName

public java.lang.String getLocaleName()
Returns:
Returns the localeName.

setLocaleName

public void setLocaleName(java.lang.String localeName)
Parameters:
localeName - The localeName to set.

getParentGroup

public Attribute getParentGroup()

setParentGroup

public void setParentGroup(Attribute parentAttribute)

prepareAttributeParentPath

protected java.lang.String prepareAttributeParentPath()

getAttributeParentPath

public java.lang.String getAttributeParentPath()

getParentPath

public java.lang.String getParentPath()
Returns:
string

setParentPath

public void setParentPath(java.lang.String string)
Parameters:
string -

getHashName

public java.lang.String getHashName()
Returns:
string

setHashName

public void setHashName(java.lang.String string)
Parameters:
string -

isValueChanged

public boolean isValueChanged()
Returns:
boolean

setValueChanged

public void setValueChanged(boolean b)
Parameters:
b -

hasAnyParentGroupMultivalued

public boolean hasAnyParentGroupMultivalued()

setParentGroupFlagValueChanged

public void setParentGroupFlagValueChanged()

setValidationError

public void setValidationError(java.lang.String id,
                               java.lang.String error)

getValidationError

public java.lang.String getValidationError(java.lang.String id)