tv.amwa.maj.entity
Class Locator

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Locator

All Implemented Interfaces:

Serializable, Cloneable, InterchangeObject, Locator, XMLSerializable

Direct Known Subclasses:

NetworkLocator, TextLocator

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=12544,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="Locator",
          description="The Locator class provides information to help find a file that contains the essence or to help find the physical media.")
public abstract class Locator
extends InterchangeObject
implements Locator, Serializable, Cloneable

Implements the representation of information to help find a file that contains the essence or to help find the physical media.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

Locator.LocatorXMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject

InterchangeObject.InterchangeObjectXMLHandler

Constructor Summary

Locator()

Method Summary

void	appendXMLChildren(Node parent) Append child elements to the given parent node to serialize the value of an object to an XML fragment.
Locator	clone()
boolean	equals(Object o)
String	getPath() Returns the path string property of this locator, which provides access to the URLString property of a network locator and the name property of a text locator.
int	hashCode()
void	setPath(String path) Sets the path string property of this locator, which provides access to the URLString property of a network locator and the name property of a text locator.
void	setPropertiesFromInterface(Locator castFrom)

Methods inherited from class tv.amwa.maj.entity.InterchangeObject

castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Constructor Detail

Locator

public Locator()

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(Locator castFrom)

See Also:

InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getPath

public String getPath()

Description copied from interface: Locator

Returns the path string property of this locator, which provides access to the URLString property of a network locator and the name property of a text locator.

Specified by:

getPath in interface Locator

Returns:

Path string property of this locator.

setPath

public void setPath(String path)
             throws NullPointerException

Description copied from interface: Locator

Sets the path string property of this locator, which provides access to the URLString property of a network locator and the name property of a text locator.

Specified by:

setPath in interface Locator

Parameters:

path - Path string property of this locator.

Throws:

NullPointerException - The given path is null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Locator clone()

Overrides:

clone in class Object

appendXMLChildren

public void appendXMLChildren(Node parent)

Description copied from interface: XMLSerializable

Append child elements to the given parent node to serialize the value of an object to an XML fragment. Methods of the XMLBuilder class are provided to help with this process.

Specified by:

appendXMLChildren in interface XMLSerializable

Overrides:

appendXMLChildren in class InterchangeObject

Parameters:

parent - XML parent element to append child nodes to.