Package org.apache.uima.resource.impl

Class FileResourceSpecifier_impl

java.lang.Object

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

org.apache.uima.resource.impl.FileResourceSpecifier_impl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, FileResourceSpecifier, MetaDataObject, ResourceSpecifier, XMLizable

public class FileResourceSpecifier_impl
extends MetaDataObject_impl
implements FileResourceSpecifier

Reference implementation of FileResourceSpecifier.

See Also:

Serialized Form

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

Modifier and Type	Field	Description
private java.lang.String	mFileUrl	URL of the file.
private java.lang.String	mLocalCache	Filename of the local cache (null if none).
(package private) static long	serialVersionUID
private static XmlizationInfo	XMLIZATION_INFO

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

serialContext

Constructor Summary

Constructors

Constructor	Description
FileResourceSpecifier_impl()	Creates a new FileResourceSpecifier_impl.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFileUrl()	UIMA-5274 Expand any references to external overrides when name and location are fetched.
java.lang.String	getLocalCache()	Gets the file name for the local cache of a remote resource file.
protected XmlizationInfo	getXmlizationInfo()	To be implemented by subclasses to return information describing how to represent this object in XML.
void	setFileUrl(java.lang.String aUrl)	Sets the URL of the file.
void	setLocalCache(java.lang.String aFileName)	Sets the file name for the local cache of a remote resource file.

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, 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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

mFileUrl

private java.lang.String mFileUrl

URL of the file.

mLocalCache

private java.lang.String mLocalCache

Filename of the local cache (null if none).

XMLIZATION_INFO

private static final XmlizationInfo XMLIZATION_INFO

Constructor Detail

FileResourceSpecifier_impl

public FileResourceSpecifier_impl()

Creates a new FileResourceSpecifier_impl.

Method Detail

getFileUrl

public java.lang.String getFileUrl()

UIMA-5274 Expand any references to external overrides when name and location are fetched. Cache the value if the evaluation succeeds (later fetches may not have the settings defined!) Leave value unmodified if any settings are undefined and log a warning message.

Specified by:

getFileUrl in interface FileResourceSpecifier

Returns:

a URL string

See Also:

FileResourceSpecifier.getFileUrl()

setFileUrl

public void setFileUrl(java.lang.String aUrl)

Description copied from interface: FileResourceSpecifier

Sets the URL of the file.

Specified by:

setFileUrl in interface FileResourceSpecifier

Parameters:

aUrl - a URL string

See Also:

FileResourceSpecifier.setFileUrl(String)

getLocalCache

public java.lang.String getLocalCache()

Description copied from interface: FileResourceSpecifier

Gets the file name for the local cache of a remote resource file. This is optional.

Specified by:

getLocalCache in interface FileResourceSpecifier

Returns:

the file name of the local cache, null if none.

See Also:

FileResourceSpecifier.getLocalCache()

setLocalCache

public void setLocalCache(java.lang.String aFileName)

Description copied from interface: FileResourceSpecifier

Sets the file name for the local cache of a remote resource file. This is optional.

Specified by:

setLocalCache in interface FileResourceSpecifier

Parameters:

aFileName - file name of the local cache, null if none.

See Also:

FileResourceSpecifier.setLocalCache(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