|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.FeatureDescription_impl
public class FeatureDescription_impl
Reference implementation of FeatureDescription
. Under construction.
Constructor Summary | |
---|---|
FeatureDescription_impl()
Creates a new FeatureDescription_impl with null field values. |
|
FeatureDescription_impl(java.lang.String aName,
java.lang.String aDescription,
java.lang.String aRangeTypeName)
Creates a new FeatureDescription_impl with the specified field values. |
|
FeatureDescription_impl(java.lang.String aName,
java.lang.String aDescription,
java.lang.String aRangeTypeName,
java.lang.String aElementTypeName,
java.lang.Boolean aMultipleReferencesAllowed)
Creates a new FeatureDescription_impl with the specified field values. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Gets the verbose description of this Feature. |
java.lang.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. |
java.lang.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. |
java.lang.String |
getName()
Gets the name of this Feature. |
java.lang.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(java.lang.String aDescription)
Sets the verbose description of this Feature. |
void |
setElementType(java.lang.String aElementType)
For a multi-valued (array or list) feature, sets the expected type of the elements of that array or list. |
void |
setMultipleReferencesAllowed(java.lang.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(java.lang.String aName)
Sets the name of this Feature. |
void |
setRangeTypeName(java.lang.String aTypeName)
Sets the name of the range Type of this Feature. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject |
---|
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl |
Methods inherited from interface org.apache.uima.util.XMLizable |
---|
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML |
Constructor Detail |
---|
public FeatureDescription_impl()
public FeatureDescription_impl(java.lang.String aName, java.lang.String aDescription, java.lang.String aRangeTypeName)
aName
- name of the featureaDescription
- verbose description of the featureaRangeTypeName
- name of the feature's range typepublic FeatureDescription_impl(java.lang.String aName, java.lang.String aDescription, java.lang.String aRangeTypeName, java.lang.String aElementTypeName, java.lang.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.Method Detail |
---|
public java.lang.String getName()
FeatureDescription
getName
in interface FeatureDescription
org.apache.uima.cas.FeatureDescription#getName()
public void setName(java.lang.String aName)
FeatureDescription
setName
in interface FeatureDescription
aName
- the name of this Featureorg.apache.uima.cas.FeatureDescription#setName(String)
public java.lang.String getDescription()
FeatureDescription
getDescription
in interface FeatureDescription
org.apache.uima.analysis_engine.metadata.FeatureDescription#getDescription()
public void setDescription(java.lang.String aDescription)
FeatureDescription
setDescription
in interface FeatureDescription
aDescription
- the description of this Featureorg.apache.uima.analysis_engine.metadata.FeatureDescription#setDescription(java.lang.String)
public java.lang.String getRangeTypeName()
FeatureDescription
getRangeTypeName
in interface FeatureDescription
org.apache.uima.cas.FeatureDescription#getRangeTypeName()
public void setRangeTypeName(java.lang.String aTypeName)
FeatureDescription
setRangeTypeName
in interface FeatureDescription
aTypeName
- the name of the range Type of this Featureorg.apache.uima.cas.FeatureDescription#setRangeTypeName(String)
public java.lang.String getElementType()
FeatureDescription
getElementType
in interface FeatureDescription
public java.lang.Boolean getMultipleReferencesAllowed()
FeatureDescription
This 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 FeatureDescription
public void setElementType(java.lang.String aElementType)
FeatureDescription
setElementType
in interface FeatureDescription
aElementType
- the expected element type of an array or list feature, null if there is no
restriction.public void setMultipleReferencesAllowed(java.lang.Boolean aAllowed)
FeatureDescription
This 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 FeatureDescription
aAllowed
- true if multiple references to an array or list are allowed, false if not.protected XmlizationInfo getXmlizationInfo()
MetaDataObject_impl
getXmlizationInfo
in class MetaDataObject_impl
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |