org.apache.uima.resource.impl

Class ExternalResourceDependency_impl

java.lang.Object

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

org.apache.uima.resource.impl.ExternalResourceDependency_impl

All Implemented Interfaces:

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

public class ExternalResourceDependency_impl
extends MetaDataObject_impl
implements ExternalResourceDependency

Reference implementation of ExternalResourceDependency.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExternalResourceDependency_impl()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() Retrieves the textual description of the resource.
java.lang.String	getInterfaceName() Retrieves the name of the Java interface through which this resource will be accessed.
java.lang.String	getKey() Retrieves the key by which the resource is identified.
protected XmlizationInfo	getXmlizationInfo() To be implemented by subclasses to return information describing how to represent this object in XML.
boolean	isOptional() Gets whether this resource dependency is optional.
void	setDescription(java.lang.String aDescription) Retrieves the textual description of the resource.
void	setInterfaceName(java.lang.String aName) Sets the name of the Java interface through which this resource will be accessed.
void	setKey(java.lang.String aKey) Sets the key by which the resource is identified.
void	setOptional(boolean aOptional) Sets whether this resource dependency is optional.

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

ExternalResourceDependency_impl

public ExternalResourceDependency_impl()

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: ExternalResourceDependency

Retrieves the key by which the resource is identified.

Specified by:

getKey in interface ExternalResourceDependency

Returns:

the key for this resource.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#getKey()

getInterfaceName

public java.lang.String getInterfaceName()

Description copied from interface: ExternalResourceDependency

Retrieves the name of the Java interface through which this resource will be accessed.

Specified by:

getInterfaceName in interface ExternalResourceDependency

Returns:

the name of the Java interface for this external resource, null if none.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#getInterfaceName()

setKey

public void setKey(java.lang.String aKey)

Description copied from interface: ExternalResourceDependency

Sets the key by which the resource is identified.

Specified by:

setKey in interface ExternalResourceDependency

Parameters:

aKey - the key for this resource.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#setKey(String)

setInterfaceName

public void setInterfaceName(java.lang.String aName)

Description copied from interface: ExternalResourceDependency

Sets the name of the Java interface through which this resource will be accessed.

Specified by:

setInterfaceName in interface ExternalResourceDependency

Parameters:

aName - the name of the Java interface for this external resource, null if none.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#setInterfaceName(String)

getDescription

public java.lang.String getDescription()

Description copied from interface: ExternalResourceDependency

Retrieves the textual description of the resource.

Specified by:

getDescription in interface ExternalResourceDependency

Returns:

the textual description of the resource.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#getDescription()

isOptional

public boolean isOptional()

Description copied from interface: ExternalResourceDependency

Gets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.

Specified by:

isOptional in interface ExternalResourceDependency

Returns:

true if this resource dependency is optional, false if not

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#isOptional()

setDescription

public void setDescription(java.lang.String aDescription)

Description copied from interface: ExternalResourceDependency

Retrieves the textual description of the resource.

Specified by:

setDescription in interface ExternalResourceDependency

Parameters:

aDescription - the textual description of the resource.

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#setDescription(java.lang.String)

setOptional

public void setOptional(boolean aOptional)

Description copied from interface: ExternalResourceDependency

Sets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.

Specified by:

setOptional in interface ExternalResourceDependency

Parameters:

aOptional - true if this resource dependency is optional, false if not

See Also:

org.apache.uima.analysis_engine.ExternalResourceDependency#setOptional(boolean)

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