gate.util.persistence

Class PersistenceManager.URLHolder

java.lang.Object

gate.util.persistence.PersistenceManager.URLHolder

All Implemented Interfaces:

Persistence, Serializable

Enclosing class:

PersistenceManager

public static class PersistenceManager.URLHolder
extends Object
implements Persistence

URLs get upset when serialised and deserialised so we need to convert them to strings for storage. In the case of "file:" URLs the relative path to the persistence file will actually be stored, except when PersistenceManager.saveObjectToFile(Object,File,boolean,boolean) was used and there is one of the following cases:

• when the URL refers to a resource within the current GATE home directory and the persistence file is not within the GATE home directory, in which case the relative path to the GATE home directory will be stored.
• Otherwise, if the persistence file is not within the GATE directory and if the property gate.user.resourceshome is set to a directory path and the URL refers to a resource inside this directory, the relative path to this directory will be stored.

If resources are stored relative to gate home or resources home, a warning will also be logged.

The real path as returned by getCanonicalPath() is used to check if the resource is within a special directory (e.g. GATE HOME). Once we know this, and the resource is in a special directory, the canonical paths are used to generate the relative path. If we are not inside a special directory, then the non-canonical path names will be used, so that any symbolic links are NOT getting resolved, which is usually what you want. The non-canonical path names will get normalized to remove things like "../dir" and the result of the normalization is checked using getCanonicalPath() to see if it refers to the same location as the non-normalized one (it could be different if the .. follows a symbolic link, for example). If it is the same, then the normalized version is used, otherwise the original version is used.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
URLHolder()

Method Summary

Modifier and Type	Method and Description
static URI	combineContextAndRelative(URI context, String relative, boolean contextIsFile)
Object	createObject() Creates a new object from the data contained.
void	extractDataFromSource(Object source) Populates this Persistence with the data that needs to be stored from the original source object.
static String	getRelativeUri(URI context, URI target)
static String	relativize(File outFile, File urlFile)
static URI	unpackPersistentRepresentation(URI context, String persistent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

URLHolder

public URLHolder()

Method Detail

relativize

public static String relativize(File outFile,
                                File urlFile)
                         throws URISyntaxException

Throws:

URISyntaxException

extractDataFromSource

public void extractDataFromSource(Object source)
                           throws PersistenceException

Description copied from interface: Persistence

Populates this Persistence with the data that needs to be stored from the original source object.

Specified by:

extractDataFromSource in interface Persistence

Throws:

PersistenceException

createObject

public Object createObject()
                    throws PersistenceException

Creates a new object from the data contained. This new object is supposed to be a copy for the original object used as source for data extraction.

Specified by:

createObject in interface Persistence

Throws:

PersistenceException

unpackPersistentRepresentation

public static URI unpackPersistentRepresentation(URI context,
                                                 String persistent)
                                          throws PersistenceException

Throws:

PersistenceException

combineContextAndRelative

public static URI combineContextAndRelative(URI context,
                                            String relative,
                                            boolean contextIsFile)

getRelativeUri

public static String getRelativeUri(URI context,
                                    URI target)