public class FeatureDescription_impl extends MetaDataObject_impl implements FeatureDescription
FeatureDescription. Under construction.MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.SerializerserialContext| Constructor and Description |
|---|
FeatureDescription_impl()
Creates a new FeatureDescription_impl with null field values.
|
FeatureDescription_impl(String aName,
String aDescription,
String aRangeTypeName)
Creates a new FeatureDescription_impl with the specified field values.
|
FeatureDescription_impl(String aName,
String aDescription,
String aRangeTypeName,
String aElementTypeName,
Boolean aMultipleReferencesAllowed)
Creates a new FeatureDescription_impl with the specified field values.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getDescription()
Gets the verbose description of this Feature.
|
String |
getElementType()
For a feature with a range type that is an array or list, gets the expected type of the
elements of that array or list.
|
Boolean |
getMultipleReferencesAllowed()
For a feature with a range type that is an array or list, gets whether value of the feature may
also be referenced from another feature elsewhere in the CAS.
|
String |
getName()
Gets the name of this Feature.
|
String |
getRangeTypeName()
Gets the name of the range Type of this Feature.
|
protected XmlizationInfo |
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object
in XML.
|
void |
setDescription(String aDescription)
Sets the verbose description of this Feature.
|
void |
setElementType(String aElementType)
For a multi-valued (array or list) feature, sets the expected type of the elements of that
array or list.
|
void |
setMultipleReferencesAllowed(Boolean aAllowed)
For a feature with a range type that is an array or list, sets whether value of the feature may
also be referenced from another feature elsewhere in the CAS.
|
void |
setName(String aName)
Sets the name of this Feature.
|
void |
setRangeTypeName(String aTypeName)
Sets the name of the range Type of this Feature.
|
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementfinalize, getClass, notify, notifyAll, wait, wait, waitclone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLpublic FeatureDescription_impl()
public FeatureDescription_impl(String aName, String aDescription, String aRangeTypeName)
aName - name of the featureaDescription - verbose description of the featureaRangeTypeName - name of the feature's range typepublic FeatureDescription_impl(String aName, String aDescription, String aRangeTypeName, String aElementTypeName, Boolean aMultipleReferencesAllowed)
aName - name of the featureaDescription - verbose description of the featureaRangeTypeName - name of the feature's range typeaElementTypeName - type of element expected to be contained in the array or listaMultipleReferencesAllowed - whether an array or list that's assigned to this feature can also be referenced from
another feature. This is a Boolean object so that the null value can be used to
represent the case where the user has not specified a value.public String getName()
FeatureDescriptiongetName in interface FeatureDescriptionFeatureDescription.getName()public void setName(String aName)
FeatureDescriptionsetName in interface FeatureDescriptionaName - the name of this FeatureFeatureDescription.setName(String)public String getDescription()
FeatureDescriptiongetDescription in interface FeatureDescriptionFeatureDescription.getDescription()public void setDescription(String aDescription)
FeatureDescriptionsetDescription in interface FeatureDescriptionaDescription - the description of this FeatureFeatureDescription.setDescription(java.lang.String)public String getRangeTypeName()
FeatureDescriptiongetRangeTypeName in interface FeatureDescriptionFeatureDescription.getRangeTypeName()public void setRangeTypeName(String aTypeName)
FeatureDescriptionsetRangeTypeName in interface FeatureDescriptionaTypeName - the name of the range Type of this FeatureFeatureDescription.setRangeTypeName(String)public String getElementType()
FeatureDescriptiongetElementType in interface FeatureDescriptionpublic Boolean getMultipleReferencesAllowed()
FeatureDescriptionThis returns a Boolean object so that we can distinguish whether the descriptor contained no setting (null) versus an explicit setting of false. We want to preserve this if the descriptor is written out again.
Setting this to false (the default) indicates that this feature has exclusive ownership of the array or list, so changes to the array or list are localized. Setting this to true indicates that the array or list may be shared, so changes to it may affect other objects in the CAS.
There is currently no guarantee that the framework will enforce this restriction. However, this setting may affect how the CAS is serialized.
This property should always be null for features whose range type is not an array or list.
getMultipleReferencesAllowed in interface FeatureDescriptionpublic void setElementType(String aElementType)
FeatureDescriptionsetElementType in interface FeatureDescriptionaElementType - the expected element type of an array or list feature, null if there is no
restriction.public void setMultipleReferencesAllowed(Boolean aAllowed)
FeatureDescriptionThis takes a Boolean object so that we can distinguish whether the descriptor contained no setting (null) versus an explicit setting of false. We want to preserve this if the descriptor is written out again.
Setting this to false (the default) indicates that this feature has exclusive ownership of the array or list, so changes to the array or list are localized. Setting this to true indicates that the array or list may be shared, so changes to it may affect other objects in the CAS.
There is currently no guarantee that the framework will enforce this restriction. However, this setting may affect how the CAS is serialized.
This property should never be set for features whose range type is not an array or list.
setMultipleReferencesAllowed in interface FeatureDescriptionaAllowed - true if multiple references to an array or list are allowed, false if not.protected XmlizationInfo getXmlizationInfo()
MetaDataObject_implgetXmlizationInfo in class MetaDataObject_implCopyright © 2006–2021 The Apache Software Foundation. All rights reserved.