Package 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:
Serializable,Cloneable,MetaDataObject,ResourceServiceSpecifier,ResourceSpecifier,URISpecifier,XMLizable
Reference implementation of
URISpecifier.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer -
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContextFields inherited from interface org.apache.uima.resource.URISpecifier
RESOURCE_TYPE_ANALYSIS_ENGINE, RESOURCE_TYPE_CAS_CONSUMER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the Protocol used to communicate with the service.Retrieves the type of Resource (e.g.Gets the timeout period in milliseconds.getUri()Retrieves the URI at which a Resource may be located.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidsetParameters(Parameter[] parameters) voidsetProtocol(String aProtocol) Sets the name of the Protocol used to communicate with the service.voidsetResourceType(String aResourceType) Sets the type of Resource (e.g.voidsetTimeout(Integer aTimeout) Sets the timeout period in milliseconds.voidSets 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, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Constructor Details
-
URISpecifier_impl
public URISpecifier_impl()Creates a newURISpecifier_impl.
-
-
Method Details
-
getUri
Description copied from interface:URISpecifierRetrieves the URI at which a Resource may be located.- Specified by:
getUriin interfaceURISpecifier- Returns:
- a URI string
- See Also:
-
setUri
Description copied from interface:URISpecifierSets the URI at which a Resource may be located.- Specified by:
setUriin interfaceURISpecifier- Parameters:
aUri- a URI string- See Also:
-
getProtocol
Description copied from interface:URISpecifierGets the name of the Protocol used to communicate with the service. Protocol names are defined in theConstantsclass.- Specified by:
getProtocolin interfaceURISpecifier- Returns:
- the name of the protocol.
- See Also:
-
setProtocol
Description copied from interface:URISpecifierSets the name of the Protocol used to communicate with the service. Protocol names are defined in theConstantsclass.- Specified by:
setProtocolin interfaceURISpecifier- Parameters:
aProtocol- the name of the protocol.- See Also:
-
getTimeout
Description copied from interface:URISpecifierGets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.- Specified by:
getTimeoutin interfaceURISpecifier- Returns:
- the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.
- See Also:
-
setTimeout
Description copied from interface:URISpecifierSets the timeout period in milliseconds. If a call takes longer than this amount of time, an exception will be thrown.- Specified by:
setTimeoutin interfaceURISpecifier- Parameters:
aTimeout- the timeout period in milliseconds. A null value indicates that the transport layer's default value will be used.- See Also:
-
getResourceType
Description copied from interface:URISpecifierRetrieves 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:
getResourceTypein interfaceURISpecifier- 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
Description copied from interface:URISpecifierSets 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:
setResourceTypein interfaceURISpecifier- 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
- Specified by:
getParametersin interfaceURISpecifier- Returns:
- Returns the Parameters.
-
setParameters
- Specified by:
setParametersin interfaceURISpecifier- Parameters:
parameters- The Parameters to set.
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-