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
serialContextFields inherited from interface org.apache.uima.resource.metadata.TypeDescription
EMPTY_TYPE_DESCRIPTIONS -
Constructor Summary
ConstructorsConstructorDescriptionCreates 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 XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidsetAllowedValues(AllowedValue[] aAllowedValues) Sets the allowed values for instances of this Type.voidsetDescription(String aDescription) Sets the verbose description of this Type.voidsetFeatures(FeatureDescription[] aFeatures) Sets the descriptions of the features for this Type.voidSets the name of this Type.voidsetSupertypeName(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, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods 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:TypeDescriptionGets the name of this Type.- Specified by:
getNamein interfaceTypeDescription- Returns:
- the name of this Type
- See Also:
-
setName
Description copied from interface:TypeDescriptionSets the name of this Type.- Specified by:
setNamein interfaceTypeDescription- Parameters:
aName- the name of this Type- See Also:
-
getDescription
Description copied from interface:TypeDescriptionGets the verbose description of this Type.- Specified by:
getDescriptionin interfaceTypeDescription- Returns:
- the description of this Type
- See Also:
-
setDescription
Description copied from interface:TypeDescriptionSets the verbose description of this Type.- Specified by:
setDescriptionin interfaceTypeDescription- Parameters:
aDescription- the description of this Type- See Also:
-
getSupertypeName
Description copied from interface:TypeDescriptionGets the name of the supertype for this Type. This is the Type from which this Type inherits.- Specified by:
getSupertypeNamein interfaceTypeDescription- Returns:
- the name of the supertype for this Type
- See Also:
-
setSupertypeName
Description copied from interface:TypeDescriptionSets the name of the supertype for this Type. This is the Type from which this Type inherits.- Specified by:
setSupertypeNamein interfaceTypeDescription- Parameters:
aTypeName- the name of the supertype for this Type- See Also:
-
getFeatures
Description copied from interface:TypeDescriptionGets the descriptions of the features for this Type.- Specified by:
getFeaturesin interfaceTypeDescription- Returns:
- the descriptions of the features for this Type.
- See Also:
-
setFeatures
Description copied from interface:TypeDescriptionSets the descriptions of the features for this Type.- Specified by:
setFeaturesin interfaceTypeDescription- Parameters:
aFeatures- descriptions of the features for this Type.- See Also:
-
getAllowedValues
Description copied from interface:TypeDescriptionGets 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:
getAllowedValuesin interfaceTypeDescription- Returns:
- the allowed values for instances of this Type
- See Also:
-
setAllowedValues
Description copied from interface:TypeDescriptionSets 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:
setAllowedValuesin 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:TypeDescriptionConvenience method which adds a FeatureDescription to this TypeDescription.- Specified by:
addFeaturein 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:TypeDescriptionConvenience method which adds a FeatureDescription to this TypeDescription. Used for array or list valued features, which have additional attributes.- Specified by:
addFeaturein 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_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-