org.apache.uima.resource.impl
Class ExternalResourceDescription_impl

java.lang.Object
  extended by org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      extended by org.apache.uima.resource.impl.ExternalResourceDescription_impl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ExternalResourceDescription, MetaDataObject, XMLizable

public class ExternalResourceDescription_impl
extends MetaDataObject_impl
implements ExternalResourceDescription

Reference implementation of AnalysisEngineDescription. Note that this class has a slightly nonstandard XML representation because the "key" property is represented in XML by an attribute rather than a child element. Therefore, we override the #toXML() method and the MetaDataObject_impl.buildFromXMLElement(Element,XMLParser) method.

See Also:
Serialized Form

Constructor Summary
ExternalResourceDescription_impl()
           
 
Method Summary
 java.lang.String getDescription()
          Retrieves the textual description of the resource.
 java.lang.String getImplementationName()
          Retrieves the name of the Java class to be instantiated from the resource data.
 java.lang.String getName()
          Retrieves the name by which the resource is identified.
 ResourceSpecifier getResourceSpecifier()
          Retrieves the ResourceSpecifier that describes how to create the resource.
protected  XmlizationInfo getXmlizationInfo()
          To be implemented by subclasses to return information describing how to represent this object in XML.
 void setDescription(java.lang.String aDescription)
          Retrieves the textual description of the resource.
 void setImplementationName(java.lang.String aName)
          Sets the name of the Java class to be instantiated from the resource data.
 void setName(java.lang.String aName)
          Sets the name by which the resource is identified.
 void setResourceSpecifier(ResourceSpecifier aSpecifier)
          Sets the ResourceSpecifier that describes how to create the resource.
 
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

ExternalResourceDescription_impl

public ExternalResourceDescription_impl()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: ExternalResourceDescription
Retrieves the name by which the resource is identified.

Specified by:
getName in interface ExternalResourceDescription
Returns:
the name of this resource.
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#getName()

getResourceSpecifier

public ResourceSpecifier getResourceSpecifier()
Description copied from interface: ExternalResourceDescription
Retrieves the ResourceSpecifier that describes how to create the resource.

Specified by:
getResourceSpecifier in interface ExternalResourceDescription
Returns:
the ResourceSpecifier for this external resource
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#getResourceSpecifier()

getImplementationName

public java.lang.String getImplementationName()
Description copied from interface: ExternalResourceDescription
Retrieves the name of the Java class to be instantiated from the resource data. This must extend SharedResourceObject as well as the interface specified by ExternalResourceDependency.getInterfaceName().

Specified by:
getImplementationName in interface ExternalResourceDescription
Returns:
the name of the Java class implementing the resource access
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#getImplementationName()

setName

public void setName(java.lang.String aName)
Description copied from interface: ExternalResourceDescription
Sets the name by which the resource is identified.

Specified by:
setName in interface ExternalResourceDescription
Parameters:
aName - the name of this resource.
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#setName(String)

setResourceSpecifier

public void setResourceSpecifier(ResourceSpecifier aSpecifier)
Description copied from interface: ExternalResourceDescription
Sets the ResourceSpecifier that describes how to create the resource.

Specified by:
setResourceSpecifier in interface ExternalResourceDescription
Parameters:
aSpecifier - the ResourceSpecifier for this external resource
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#setResourceSpecifier(ResourceSpecifier)

setImplementationName

public void setImplementationName(java.lang.String aName)
Description copied from interface: ExternalResourceDescription
Sets the name of the Java class to be instantiated from the resource data. This must extend SharedResourceObject as well as the interface specified by ExternalResourceDependency.getInterfaceName().

Specified by:
setImplementationName in interface ExternalResourceDescription
Parameters:
aName - the name of the Java class implementing the resource access
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#setImpelmentationName(String)

getDescription

public java.lang.String getDescription()
Description copied from interface: ExternalResourceDescription
Retrieves the textual description of the resource.

Specified by:
getDescription in interface ExternalResourceDescription
Returns:
the textual description of the resource.
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#getDescription()

setDescription

public void setDescription(java.lang.String aDescription)
Description copied from interface: ExternalResourceDescription
Retrieves the textual description of the resource.

Specified by:
setDescription in interface ExternalResourceDescription
Parameters:
aDescription - the textual description of the resource.
See Also:
org.apache.uima.analysis_engine.ExternalResourceDescription#setDescription(java.lang.String)

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


Copyright © 2011. All Rights Reserved.