org.apache.hivemind.schema
Interface AttributeModel

All Superinterfaces:
AnnotationHolder, Locatable
All Known Implementing Classes:
AttributeModelImpl

public interface AttributeModel
extends Locatable, AnnotationHolder

Part of a Schema, used to specify an attribute allowed within an ElementModel.

Author:
Howard Lewis Ship

Method Summary
 java.lang.String getName()
          The name of the attribute.
 java.lang.String getTranslator()
          Returns the translator used to convert the attribute value.
 boolean isRequired()
          Returns true if the attribute is required (must be specified).
 boolean isUnique()
          Returns true if the attribute is supposed to be considered unique in relation to the configuration point.
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 
Methods inherited from interface org.apache.hivemind.parse.AnnotationHolder
getAnnotation, setAnnotation
 

Method Detail

getName

java.lang.String getName()
The name of the attribute.


isRequired

boolean isRequired()
Returns true if the attribute is required (must be specified). Otherwise, the attribute is optional and may be omitted.


getTranslator

java.lang.String getTranslator()
Returns the translator used to convert the attribute value. This is used to locate a Translator.


isUnique

boolean isUnique()
Returns true if the attribute is supposed to be considered unique in relation to the configuration point.

Returns:
True if the attribute must be unique with respect to it's xpath, otherwise false