org.apache.uima.resource.impl
Class URISpecifier_impl

java.lang.Object
  org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      org.apache.uima.resource.impl.URISpecifier_impl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, MetaDataObject, ResourceServiceSpecifier, ResourceSpecifier, URISpecifier, XMLizable

public class URISpecifier_impl
extends MetaDataObject_impl
implements URISpecifier

Reference implementation of URISpecifier.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.uima.resource.URISpecifier

RESOURCE_TYPE_ANALYSIS_ENGINE, RESOURCE_TYPE_CAS_CONSUMER

Constructor Summary

URISpecifier_impl()
Creates a new URISpecifier_impl.

Method Summary

Parameter[]	getParameters()
java.lang.String	getProtocol() Gets the name of the Protocol used to communicate with the service.
java.lang.String	getResourceType() Retrieves the type of Resource (e.g.
java.lang.Integer	getTimeout() Gets the timeout period in milliseconds.
java.lang.String	getUri() Retrieves the URI at which a Resource may be located.
protected XmlizationInfo	getXmlizationInfo() To be implemented by subclasses to return information describing how to represent this object in XML.
void	setParameters(Parameter[] parameters)
void	setProtocol(java.lang.String aProtocol) Sets the name of the Protocol used to communicate with the service.
void	setResourceType(java.lang.String aResourceType) Sets the type of Resource (e.g.
void	setTimeout(java.lang.Integer aTimeout) Sets the timeout period in milliseconds.
void	setUri(java.lang.String aUri) Sets the URI at which a Resource may be located.

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

URISpecifier_impl

public URISpecifier_impl()

Creates a new URISpecifier_impl.

Method Detail

getUri

public java.lang.String getUri()

Description copied from interface: URISpecifier

Retrieves the URI at which a Resource may be located.

Specified by:

getUri in interface URISpecifier

Returns:

a URI string

See Also:

org.apache.uima.resrouce.URISpecifier#getURI()

setUri

public void setUri(java.lang.String aUri)

Description copied from interface: URISpecifier

Sets the URI at which a Resource may be located.

Specified by:

setUri in interface URISpecifier

Parameters:

aUri - a URI string

See Also:

org.apache.uima.resrouce.URISpecifier#setURI(String)

getProtocol

public java.lang.String getProtocol()

Description copied from interface: URISpecifier

Gets the name of the Protocol used to communicate with the service. Protocol names are defined in the Constants class.

Specified by:

getProtocol in interface URISpecifier

Returns:

the name of the protocol.

See Also:

org.apache.uima.resrouce.URISpecifier#getProtocol()

setProtocol

public void setProtocol(java.lang.String aProtocol)

Description copied from interface: URISpecifier

Sets the name of the Protocol used to communicate with the service. Protocol names are defined in the Constants class.

Specified by:

setProtocol in interface URISpecifier

Parameters:

aProtocol - the name of the protocol.

See Also:

org.apache.uima.resrouce.URISpecifier#setProtocol(String)

getTimeout

public java.lang.Integer getTimeout()

Description copied from interface: URISpecifier

Gets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.

Specified by:

getTimeout in interface URISpecifier

Returns:

the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.

See Also:

URISpecifier.getTimeout()

setTimeout

public void setTimeout(java.lang.Integer aTimeout)

Description copied from interface: URISpecifier

Sets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.

Specified by:

setTimeout in interface URISpecifier

Parameters:

aTimeout - the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.

See Also:

org.apache.uima.resource.URISpecifier#setTimeout(int)

getResourceType

public java.lang.String getResourceType()

Description copied from interface: URISpecifier

Retrieves the type of Resource (e.g. Analysis Engine, CAS Consumer) that the service at this URI is expected to implement. This is optional, but useful for clients to know what to do with the URISpecifier.

Specified by:

getResourceType in interface URISpecifier

Returns:

the type of Resource. This should be one of the constants on this class, or null if the resource type is not specified.

setResourceType

public void setResourceType(java.lang.String aResourceType)

Description copied from interface: URISpecifier

Sets the type of Resource (e.g. Analysis Engine, CAS Consumer) that the service at this URI is expected to implement. This is optional, but useful for clients to know what to do with the URISpecifier.

Specified by:

setResourceType in interface URISpecifier

Parameters:

aResourceType - the type of Resource. This should be one of the constants on this class, or null to indicate that the resource type is not specified.

getParameters

public Parameter[] getParameters()

Specified by:

getParameters in interface URISpecifier

Returns:

Returns the Parameters.

setParameters

public void setParameters(Parameter[] parameters)

Specified by:

setParameters in interface URISpecifier

Parameters:

parameters - The Parameters to set.

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