charger.util

Class ObjectLocator

Object

charger.util.ObjectLocator

public class ObjectLocator
extends Object

Object containing the information needed to uniquely identify and access an object in the CharGer system. Contains no dynamic addresses, serialization, etc. Objects currently accessible include GNodes and RepertoryGrids.

An object locator consists of a (local) file name, a fully qualified class name and a unique ident. The file name may be null.

In the future, this should probably be handled as a fully-qualified URI, but it works as an adequate substitute.

See Also:

WindowManager

Field Summary

Fields

Modifier and Type	Field and Description
private Class	_class type of object being located
private GraphObjectID	_ID unique ID for identification
private File	_sourceFile absolute file (if any) where object is located

Constructor Summary

Constructors

Constructor and Description
ObjectLocator(File f, Class c, GraphObjectID id) Creates a new object locator with the given constituents.
ObjectLocator(File f, GraphObjectID id) Creates a locator with the given file and ident, and class java.lang.Object
ObjectLocator(String filename, GraphObjectID id) Creates a locator with the given file and ident, and class java.lang.Object

Method Summary

Modifier and Type	Method and Description
File	getFile() Gets the file portion of the locator.
GraphObjectID	getID() Gets the file portion of the locator.
Object	getObject(boolean makeAvailable) Find the object that this locator is intended to identify.
static Object	getObject(File f, GraphObjectID id, Class c, boolean makeAvailable) Find the object, wherever it is, opening its window if necessary.
private static Class	getRelevantClass(Class c)
private void	initialize(File f, Class c, GraphObjectID id)
boolean	isAccessible()
static ObjectLocator	parseURI(String uri) Construct an object locator from its URI string.
void	setFile(File f) Sets the file portion of the locator
void	setID(GraphObjectID id)
String	toURI() Creates a URI to identify this object.
String	toXML(String indent)

Methods inherited from class Object

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

Field Detail

_sourceFile

private File _sourceFile

absolute file (if any) where object is located

_ID

private GraphObjectID _ID

unique ID for identification

_class

private Class _class

type of object being located

Constructor Detail

ObjectLocator

public ObjectLocator(File f,
                     Class c,
                     GraphObjectID id)

Creates a new object locator with the given constituents.

ObjectLocator

public ObjectLocator(File f,
                     GraphObjectID id)

Creates a locator with the given file and ident, and class java.lang.Object

Parameters:

f - file where this object is currently stored.

id - an id that is unique across all locatable objects on the current host.

ObjectLocator

public ObjectLocator(String filename,
                     GraphObjectID id)

Creates a locator with the given file and ident, and class java.lang.Object

Method Detail

initialize

private void initialize(File f,
                        Class c,
                        GraphObjectID id)

getFile

public File getFile()

Gets the file portion of the locator.

Returns:

source file of the object sought; null if it's not in a file.

setFile

public void setFile(File f)

Sets the file portion of the locator

getID

public GraphObjectID getID()

Gets the file portion of the locator.

Returns:

ident of the object sought; 0 (zero) if it has no ident.

setID

public void setID(GraphObjectID id)

getObject

public static Object getObject(File f,
                               GraphObjectID id,
                               Class c,
                               boolean makeAvailable)

Find the object, wherever it is, opening its window if necessary.

getObject

public Object getObject(boolean makeAvailable)

Find the object that this locator is intended to identify.

Parameters:

makeAvailable - Whether to open up the resource and make the object available. If false, and the the object is not currently accessbiel, then return null.

Returns:

the object in question; otherwise null.

isAccessible

public boolean isAccessible()

getRelevantClass

private static Class getRelevantClass(Class c)

toXML

public String toXML(String indent)

toURI

public String toURI()

Creates a URI to identify this object. The URI looks like file:/Volumes/hsd/Research/CGs/catonmat.cgx#charger.obj.Concept-12345667 where the URI fragment (after the "#") is the class type and the ID number.

parseURI

public static ObjectLocator parseURI(String uri)

Construct an object locator from its URI string.

See Also:

URI, toURI()