org.apache.uima.resource.metadata.impl

Class TypeSystemDescription_impl

java.lang.Object

org.apache.uima.resource.metadata.impl.MetaDataObject_impl

org.apache.uima.resource.metadata.impl.TypeSystemDescription_impl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, MetaDataObject, TypeSystemDescription, XMLizable

public class TypeSystemDescription_impl
extends MetaDataObject_impl
implements TypeSystemDescription

Reference implementation of TypeSystemDescription.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypeSystemDescription_impl() Creates a new TypeSystemDescription_impl.

Method Summary

Methods

Modifier and Type	Method and Description
TypeDescription	addType(java.lang.String aTypeName, java.lang.String aDescription, java.lang.String aSupertypeName) Adds a Type to this TypeSystem fragment.
java.lang.String	getDescription() Gets the description of this Type System.
Import[]	getImports() Gets the imports declared by this Type System.
java.lang.String	getName() Gets the name of this Type System.
TypeDescription	getType(java.lang.String aTypeName) Retrieves a Type from this TypeSystem fragment.
TypeDescription[]	getTypes() Gets descriptions of all Types in this TypeSystem fragment.
java.lang.String	getVendor() Gets the vendor of this Type System.
java.lang.String	getVersion() Gets the version number of this Type System.
protected XmlizationInfo	getXmlizationInfo() To be implemented by subclasses to return information describing how to represent this object in XML.
void	resolveImports() Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list.
void	resolveImports(java.util.Collection<java.lang.String> aAlreadyImportedTypeSystemURLs, ResourceManager aResourceManager) Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list.
void	resolveImports(ResourceManager aResourceManager) Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list.
void	setDescription(java.lang.String aDescription) Sets the description of this Type System.
void	setImports(Import[] aImports) Sets the imports declared by this Type System.
void	setName(java.lang.String aName) Sets the name of this Type System.
void	setTypes(TypeDescription[] aTypes) Sets the descriptions of all Types in this TypeSystem fragment.
void	setVendor(java.lang.String aVendor) Sets the vendor of this Type System.
void	setVersion(java.lang.String aVersion) Sets the version number of this Type System.

Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl

buildFromXMLElement, buildFromXMLElement, clone, equals, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, 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 Detail

TypeSystemDescription_impl

public TypeSystemDescription_impl()

Creates a new TypeSystemDescription_impl.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TypeSystemDescription

Gets the name of this Type System.

Specified by:

getName in interface TypeSystemDescription

Returns:

the name of this Type System, null if none has been specified.

See Also:

org.apache.uima.resource.ResourceMetaData#getName()

setName

public void setName(java.lang.String aName)

Description copied from interface: TypeSystemDescription

Sets the name of this Type System.

Specified by:

setName in interface TypeSystemDescription

Parameters:

aName - the name of this Type System

See Also:

org.apache.uima.resource.ResourceMetaData#setName(String)

getVersion

public java.lang.String getVersion()

Description copied from interface: TypeSystemDescription

Gets the version number of this Type System.

Specified by:

getVersion in interface TypeSystemDescription

Returns:

the version number of this Type System, as a String, null if none has been specified.

See Also:

org.apache.uima.resource.ResourceMetaData#getVersion()

setVersion

public void setVersion(java.lang.String aVersion)

Description copied from interface: TypeSystemDescription

Sets the version number of this Type System.

Specified by:

setVersion in interface TypeSystemDescription

Parameters:

aVersion - the version number of this Type System, as a String

See Also:

org.apache.uima.resource.ResourceMetaData#setVersion(String)

getDescription

public java.lang.String getDescription()

Description copied from interface: TypeSystemDescription

Gets the description of this Type System.

Specified by:

getDescription in interface TypeSystemDescription

Returns:

the description of this Type System, null if none has been specified.

See Also:

org.apache.uima.resource.ResourceMetaData#getDescription()

setDescription

public void setDescription(java.lang.String aDescription)

Description copied from interface: TypeSystemDescription

Sets the description of this Type System.

Specified by:

setDescription in interface TypeSystemDescription

Parameters:

aDescription - the description of this Type System

See Also:

org.apache.uima.resource.ResourceMetaData#setDescription(String)

getVendor

public java.lang.String getVendor()

Description copied from interface: TypeSystemDescription

Gets the vendor of this Type System.

Specified by:

getVendor in interface TypeSystemDescription

Returns:

the vendor of this Type System, as a String

See Also:

org.apache.uima.resource.ResourceMetaData#getVendor()

setVendor

public void setVendor(java.lang.String aVendor)

Description copied from interface: TypeSystemDescription

Sets the vendor of this Type System.

Specified by:

setVendor in interface TypeSystemDescription

Parameters:

aVendor - the vendor of this Type System, as a String, null if none has been specified.

See Also:

org.apache.uima.resource.ResourceMetaData#setVendor(String)

getImports

public Import[] getImports()

Description copied from interface: TypeSystemDescription

Gets the imports declared by this Type System.

Specified by:

getImports in interface TypeSystemDescription

Returns:

an array of imports declared by this type system.

setImports

public void setImports(Import[] aImports)

Description copied from interface: TypeSystemDescription

Sets the imports declared by this Type System.

Specified by:

setImports in interface TypeSystemDescription

Parameters:

aImports - an array of imports declared by this type system.

getTypes

public TypeDescription[] getTypes()

Description copied from interface: TypeSystemDescription

Gets descriptions of all Types in this TypeSystem fragment.

Specified by:

getTypes in interface TypeSystemDescription

Returns:

descriptions of all Types in this TypeSystem fragment

See Also:

org.apache.uima.cas.TypeSystemDescription#getTypes()

setTypes

public void setTypes(TypeDescription[] aTypes)

Description copied from interface: TypeSystemDescription

Sets the descriptions of all Types in this TypeSystem fragment.

Specified by:

setTypes in interface TypeSystemDescription

Parameters:

aTypes - descriptions of all Types in this TypeSystem fragment

See Also:

org.apache.uima.cas.TypeSystemDescription#setTypes(TypeDescription[])

addType

public TypeDescription addType(java.lang.String aTypeName,
                      java.lang.String aDescription,
                      java.lang.String aSupertypeName)

Description copied from interface: TypeSystemDescription

Adds a Type to this TypeSystem fragment.

Specified by:

addType in interface TypeSystemDescription

Parameters:

aTypeName - name of Type to add

aDescription - verbose description of this Type

aSupertypeName - name of supertype for the new Type

Returns:

description of the new Type

See Also:

org.apache.uima.cas.TypeSystemDescription#addType(String, String, String)

getType

public TypeDescription getType(java.lang.String aTypeName)

Description copied from interface: TypeSystemDescription

Retrieves a Type from this TypeSystem fragment.

Specified by:

getType in interface TypeSystemDescription

Parameters:

aTypeName - name of Type to retrieve

Returns:

the type with the specified name, null if no such type exists

See Also:

org.apache.uima.analysis_engine.metadata.TypeSystemDescription#getType(java.lang.String)

resolveImports

public void resolveImports()
                    throws InvalidXMLException

Description copied from interface: TypeSystemDescription

Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.

Specified by:

resolveImports in interface TypeSystemDescription

Throws:

InvalidXMLException - if either the import target does not exist or is invalid

resolveImports

public void resolveImports(ResourceManager aResourceManager)
                    throws InvalidXMLException

Description copied from interface: TypeSystemDescription

Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.

Specified by:

resolveImports in interface TypeSystemDescription

Parameters:

aResourceManager - the Resource Manager used to locate type systems imported by name. For example, the path in which to locate these type systems can be set via the ResourceManager.setDataPath(String) method.

Throws:

InvalidXMLException - if either the import target does not exist or is invalid

resolveImports

public void resolveImports(java.util.Collection<java.lang.String> aAlreadyImportedTypeSystemURLs,
                  ResourceManager aResourceManager)
                    throws InvalidXMLException

Description copied from interface: TypeSystemDescription

Resolves any import declarations in this type system, adding the imported types directly onto this TypeSystemDescription's types list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.

This version is used internally to resolve nested imports.

Specified by:

resolveImports in interface TypeSystemDescription

Parameters:

aAlreadyImportedTypeSystemURLs - URLs of already imported type systems, so we don't import them again.

aResourceManager - the Resource Manager used to locate type systems imported by name. For example, the path in which to locate these type systems can be set via the ResourceManager.setDataPath(String) method.

Throws:

InvalidXMLException - if either the import target does not exist or is invalid

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