|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgate.creole.FeatureSchema
This class describes a schema for a feature. It is used as part of
AnnotationSchema
class.
Field Summary | |
private static boolean |
DEBUG
Debug flag |
(package private) String |
featureName
The name of this feature. |
(package private) Set |
featurePermissibleValuesSet
Permisible value set, if appropriate. |
(package private) String |
featureUse
The use of that feature can be one of: prohibited | optional | required | default | fixed : optional |
(package private) String |
featureValue
The value of the feature. |
(package private) String |
featureValueClassName
The class name of the feature value |
Constructor Summary | |
FeatureSchema(String aFeatureName,
String aFeatureValueClassName,
String aFeatureValue,
String aFeatureUse,
Set aFeaturePermissibleValuesSet)
Construction given a name of an feature and a feature value class name |
Method Summary | |
boolean |
addPermissibleValue(Object obj)
Adds a value to the enumeration of permissible value for an feature of this type. |
String |
getFeatureName()
Get the feature name |
String |
getFeatureValue()
This method returns the value of the feature. |
Set |
getPermissibleValues()
Returns the permissible values as a Set |
String |
getValueClassName()
Get the feature value class name |
boolean |
isDefault()
This method is used to check if the feature is default. |
boolean |
isEnumeration()
Tests whether the values are an enumeration or not. |
boolean |
isFixed()
This method is used to check if the feature, is fixed. |
boolean |
isOptional()
This method is used to check if the feature is optional. |
boolean |
isProhibited()
This method is used to check if the feature is prohibited. |
boolean |
isRequired()
This method is used to check if the feature is required. |
void |
setFeatureValue(String aFeatureValue)
This method sets the value of the feature. |
boolean |
setPermissibleValues(Set aPermisibleValuesSet)
Adds all values from the given set as permissible values for the given feature. |
String |
toXSchema(Map aJava2XSchemaMap)
This method transforms a feature to its XSchema representation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final boolean DEBUG
String featureName
String featureValueClassName
String featureValue
String featureUse
Set featurePermissibleValuesSet
Constructor Detail |
public FeatureSchema(String aFeatureName, String aFeatureValueClassName, String aFeatureValue, String aFeatureUse, Set aFeaturePermissibleValuesSet)
Method Detail |
public boolean isEnumeration()
public String getFeatureName()
public String getValueClassName()
public Set getPermissibleValues()
public boolean setPermissibleValues(Set aPermisibleValuesSet)
public boolean addPermissibleValue(Object obj)
obj
- the object representing a permissible value. If null then
simply returns with false.public String toXSchema(Map aJava2XSchemaMap)
aJava2XSchemaMap
- a Java map object that will be serialized in XSchema
public String getFeatureValue()
public void setFeatureValue(String aFeatureValue)
aFeatureValue
- a String representing the value of a feature.public boolean isRequired()
public boolean isDefault()
public boolean isFixed()
public boolean isOptional()
public boolean isProhibited()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |