Package org.apache.uima.resource.metadata.impl

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
public class TypeDescription_impl extends MetaDataObject_impl implements TypeDescription
Reference implementation of TypeDescription. Under construction.
See Also:

  • Constructor Details

    • TypeDescription_impl

      public TypeDescription_impl()
      Creates a new TypeDescription_impl with null field values.

    • TypeDescription_impl

      public TypeDescription_impl(String aName, String aDescription, String aSupertypeName)
      Creates a new TypeDescription_impl with the specified field values.
      Parameters:
      aName - name of the Type
      aDescription - -
      aSupertypeName - name of the type's supertype

  • Method Details

    • getName

      public String getName()
      Description copied from interface: TypeDescription
      Gets the name of this Type.
      Specified by:
      getName in interface TypeDescription
      Returns:
      the name of this Type

    • setName

      public void setName(String aName)
      Description copied from interface: TypeDescription
      Sets the name of this Type.
      Specified by:
      setName in interface TypeDescription
      Parameters:
      aName - the name of this Type

    • getDescription

      public String getDescription()
      Description copied from interface: TypeDescription
      Gets the verbose description of this Type.
      Specified by:
      getDescription in interface TypeDescription
      Returns:
      the description of this Type

    • setDescription

      public void setDescription(String aDescription)
      Description copied from interface: TypeDescription
      Sets the verbose description of this Type.
      Specified by:
      setDescription in interface TypeDescription
      Parameters:
      aDescription - the description of this Type

    • getSupertypeName

      public String 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 interface TypeDescription
      Returns:
      the name of the supertype for this Type

    • setSupertypeName

      public void setSupertypeName(String aTypeName)
      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 interface TypeDescription
      Parameters:
      aTypeName - the name of the supertype for this Type

    • getFeatures

      public FeatureDescription[] getFeatures()
      Description copied from interface: TypeDescription
      Gets the descriptions of the features for this Type.
      Specified by:
      getFeatures in interface TypeDescription
      Returns:
      the descriptions of the features for this Type.

    • setFeatures

      public void setFeatures(FeatureDescription... aFeatures)
      Description copied from interface: TypeDescription
      Sets the descriptions of the features for this Type.
      Specified by:
      setFeatures in interface TypeDescription
      Parameters:
      aFeatures - descriptions of the features for this Type.

    • getAllowedValues

      public AllowedValue[] 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 return null. Note that if a type has allowed values, it may not have features.
      Specified by:
      getAllowedValues in interface TypeDescription
      Returns:
      the allowed values for instances of this Type

    • setAllowedValues

      public void setAllowedValues(AllowedValue... aAllowedValues)
      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 be null. Note that if a type has allowed values, it may not have features.
      Specified by:
      setAllowedValues in interface TypeDescription
      Parameters:
      aAllowedValues - the allowed values for instances of this Type

    • 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 interface TypeDescription
      Parameters:
      aFeatureName - name of feature to add
      aDescription - verbose description of the feature
      aRangeTypeName - name of feature's range type
      Returns:
      description of the new Feature

    • 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 interface TypeDescription
      Parameters:
      aFeatureName - name of feature to add
      aDescription - verbose description of the feature
      aRangeTypeName - name of feature's range type
      aElementTypeName - type of element expected to be contained in the array or list
      aMultipleReferencesAllowed - 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

    • getXmlizationInfo

      protected XmlizationInfo 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 class MetaDataObject_impl
      Returns:
      information defining this object's XML representation