|
||||||||||
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.TypeDescription_impl
public class TypeDescription_impl
Reference implementation of TypeDescription
. Under construction.
Constructor Summary | |
---|---|
TypeDescription_impl()
Creates a new TypeDescription_impl with null field values. |
|
TypeDescription_impl(java.lang.String aName,
java.lang.String aDescription,
java.lang.String aSupertypeName)
Creates a new TypeDescription_impl with the specified field values. |
Method Summary | |
---|---|
FeatureDescription |
addFeature(java.lang.String aFeatureName,
java.lang.String aDescription,
java.lang.String aRangeTypeName)
Convenience method which adds a FeatureDescription to this TypeDescription. |
FeatureDescription |
addFeature(java.lang.String aFeatureName,
java.lang.String aDescription,
java.lang.String aRangeTypeName,
java.lang.String aElementTypeName,
java.lang.Boolean aMultipleReferencesAllowed)
Convenience method which adds a FeatureDescription to this TypeDescription. |
AllowedValue[] |
getAllowedValues()
Gets the allowed values for instances of this Type. |
java.lang.String |
getDescription()
Gets the verbose description of this Type. |
FeatureDescription[] |
getFeatures()
Gets the descriptions of the features for this Type. |
java.lang.String |
getName()
Gets the name of this Type. |
java.lang.String |
getSupertypeName()
Gets the name of the supertype for this Type. |
protected XmlizationInfo |
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML. |
void |
setAllowedValues(AllowedValue[] aAllowedValues)
Sets the allowed values for instances of this Type. |
void |
setDescription(java.lang.String aDescription)
Sets the verbose description of this Type. |
void |
setFeatures(FeatureDescription[] aFeatures)
Sets the descriptions of the features for this Type. |
void |
setName(java.lang.String aName)
Sets the name of this Type. |
void |
setSupertypeName(java.lang.String aTypeName)
Sets the name of the supertype for this Type. |
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 TypeDescription_impl()
public TypeDescription_impl(java.lang.String aName, java.lang.String aDescription, java.lang.String aSupertypeName)
aName
- name of the TypeaSupertypeName
- name of the type's supertypeMethod Detail |
---|
public java.lang.String getName()
TypeDescription
getName
in interface TypeDescription
org.apache.uima.cas.TypeDescription#getName()
public void setName(java.lang.String aName)
TypeDescription
setName
in interface TypeDescription
aName
- the name of this Typeorg.apache.uima.cas.TypeDescription#setName(String)
public java.lang.String getDescription()
TypeDescription
getDescription
in interface TypeDescription
org.apache.uima.analysis_engine.metadata.TypeDescription#getDescription()
public void setDescription(java.lang.String aDescription)
TypeDescription
setDescription
in interface TypeDescription
aDescription
- the description of this Typeorg.apache.uima.analysis_engine.metadata.TypeDescription#setDescription(java.lang.String)
public java.lang.String getSupertypeName()
TypeDescription
getSupertypeName
in interface TypeDescription
org.apache.uima.cas.TypeDescription#getSupertypeName()
public void setSupertypeName(java.lang.String aTypeName)
TypeDescription
setSupertypeName
in interface TypeDescription
aTypeName
- the name of the supertype for this Typeorg.apache.uima.cas.TypeDescription#setSupertypeName(String)
public FeatureDescription[] getFeatures()
TypeDescription
getFeatures
in interface TypeDescription
org.apache.uima.cas.TypeDescription#getFeatures()
public void setFeatures(FeatureDescription[] aFeatures)
TypeDescription
setFeatures
in interface TypeDescription
aFeatures
- descriptions of the features for this Type.org.apache.uima.cas.TypeDescription#setFeatures(FeatureDescription[])
public AllowedValue[] getAllowedValues()
TypeDescription
null
. Note that if a type has allowed values, it may not
have features.
getAllowedValues
in interface TypeDescription
org.apache.uima.analysis_engine.metadata.TypeDescription#getAllowedValues()
public void setAllowedValues(AllowedValue[] aAllowedValues)
TypeDescription
null
. Note that if a type has allowed values, it
may not have features.
setAllowedValues
in interface TypeDescription
aAllowedValues
- the allowed values for instances of this Typeorg.apache.uima.analysis_engine.metadata.TypeDescription#setAllowedValues(org.apache.uima.analysis_engine.metadata.AllowedValue[])
public FeatureDescription addFeature(java.lang.String aFeatureName, java.lang.String aDescription, java.lang.String aRangeTypeName)
TypeDescription
addFeature
in interface TypeDescription
aFeatureName
- name of feature to addaDescription
- verbose description of the featureaRangeTypeName
- name of feature's range type
org.apache.uima.cas.TypeDescription#addFeature(String, String, String)
public FeatureDescription addFeature(java.lang.String aFeatureName, java.lang.String aDescription, java.lang.String aRangeTypeName, java.lang.String aElementTypeName, java.lang.Boolean aMultipleReferencesAllowed)
TypeDescription
addFeature
in interface TypeDescription
aFeatureName
- name of feature to addaDescription
- verbose description of the featureaRangeTypeName
- name of 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.
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 |