Class TypeDescription_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.TypeDescription_impl
- All Implemented Interfaces:
Serializable
,Cloneable
,MetaDataObject
,TypeDescription
,XMLizable
Reference implementation of
TypeDescription
. Under construction.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
-
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
Fields inherited from interface org.apache.uima.resource.metadata.TypeDescription
EMPTY_TYPE_DESCRIPTIONS
-
Constructor Summary
ConstructorDescriptionCreates a new TypeDescription_impl with null field values.TypeDescription_impl
(String aName, String aDescription, String aSupertypeName) Creates a new TypeDescription_impl with the specified field values. -
Method Summary
Modifier and TypeMethodDescriptionaddFeature
(String aFeatureName, String aDescription, String aRangeTypeName) Convenience method which adds a FeatureDescription to this TypeDescription.addFeature
(String aFeatureName, String aDescription, String aRangeTypeName, String aElementTypeName, Boolean aMultipleReferencesAllowed) Convenience method which adds a FeatureDescription to this TypeDescription.Gets the allowed values for instances of this Type.Gets the verbose description of this Type.Gets the descriptions of the features for this Type.getName()
Gets the name of this Type.Gets the name of the supertype for this Type.protected XmlizationInfo
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
(String aDescription) Sets the verbose description of this Type.void
setFeatures
(FeatureDescription[] aFeatures) Sets the descriptions of the features for this Type.void
Sets the name of this Type.void
setSupertypeName
(String aTypeName) Sets the name of the supertype for this Type.Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
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, writePropertyAsElement
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 Details
-
TypeDescription_impl
public TypeDescription_impl()Creates a new TypeDescription_impl with null field values. -
TypeDescription_impl
Creates a new TypeDescription_impl with the specified field values.- Parameters:
aName
- name of the TypeaDescription
- -aSupertypeName
- name of the type's supertype
-
-
Method Details
-
getName
Description copied from interface:TypeDescription
Gets the name of this Type.- Specified by:
getName
in interfaceTypeDescription
- Returns:
- the name of this Type
- See Also:
-
setName
Description copied from interface:TypeDescription
Sets the name of this Type.- Specified by:
setName
in interfaceTypeDescription
- Parameters:
aName
- the name of this Type- See Also:
-
getDescription
Description copied from interface:TypeDescription
Gets the verbose description of this Type.- Specified by:
getDescription
in interfaceTypeDescription
- Returns:
- the description of this Type
- See Also:
-
setDescription
Description copied from interface:TypeDescription
Sets the verbose description of this Type.- Specified by:
setDescription
in interfaceTypeDescription
- Parameters:
aDescription
- the description of this Type- See Also:
-
getSupertypeName
Description copied from interface:TypeDescription
Gets the name of the supertype for this Type. This is the Type from which this Type inherits.- Specified by:
getSupertypeName
in interfaceTypeDescription
- Returns:
- the name of the supertype for this Type
- See Also:
-
setSupertypeName
Description copied from interface:TypeDescription
Sets the name of the supertype for this Type. This is the Type from which this Type inherits.- Specified by:
setSupertypeName
in interfaceTypeDescription
- Parameters:
aTypeName
- the name of the supertype for this Type- See Also:
-
getFeatures
Description copied from interface:TypeDescription
Gets the descriptions of the features for this Type.- Specified by:
getFeatures
in interfaceTypeDescription
- Returns:
- the descriptions of the features for this Type.
- See Also:
-
setFeatures
Description copied from interface:TypeDescription
Sets the descriptions of the features for this Type.- Specified by:
setFeatures
in interfaceTypeDescription
- Parameters:
aFeatures
- descriptions of the features for this Type.- See Also:
-
getAllowedValues
Description copied from interface:TypeDescription
Gets the allowed values for instances of this Type. This is used only for special "enumerated types" that extend the String type and define a specific set of allowed values. For all other Types this will returnnull
. Note that if a type has allowed values, it may not have features.- Specified by:
getAllowedValues
in interfaceTypeDescription
- Returns:
- the allowed values for instances of this Type
- See Also:
-
setAllowedValues
Description copied from interface:TypeDescription
Sets the allowed values for instances of this Type. This is used only for special "enumerated types" that extend the String type and define a specific set of allowed values. For all other Types this property should benull
. Note that if a type has allowed values, it may not have features.- Specified by:
setAllowedValues
in interfaceTypeDescription
- Parameters:
aAllowedValues
- the allowed values for instances of this Type- See Also:
-
addFeature
public FeatureDescription addFeature(String aFeatureName, String aDescription, String aRangeTypeName) Description copied from interface:TypeDescription
Convenience method which adds a FeatureDescription to this TypeDescription.- Specified by:
addFeature
in interfaceTypeDescription
- Parameters:
aFeatureName
- name of feature to addaDescription
- verbose description of the featureaRangeTypeName
- name of feature's range type- Returns:
- description of the new Feature
- See Also:
-
addFeature
public FeatureDescription addFeature(String aFeatureName, String aDescription, String aRangeTypeName, String aElementTypeName, Boolean aMultipleReferencesAllowed) Description copied from interface:TypeDescription
Convenience method which adds a FeatureDescription to this TypeDescription. Used for array or list valued features, which have additional attributes.- Specified by:
addFeature
in interfaceTypeDescription
- Parameters:
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.- Returns:
- description of the new Feature
- See Also:
-
getXmlizationInfo
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-