tv.amwa.maj.entity
Class TextLocator

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

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, InterchangeObject, Locator, TextLocator, XMLSerializable

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

Implements a representation of information to help find a file containing the essence or to help find the physical media. A text locator is not intended for applications to use without user intervention.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

TextLocator.XMLHandler

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

Locator.LocatorXMLHandler

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

InterchangeObject.InterchangeObjectXMLHandler

Constructor Summary

TextLocator(String name)
Creates and initializes a new text locator, which provides information to help find a file containing the essence or to help find the physical media.

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.
TextLocator	clone() Creates a cloned copy of this entity.
String	getName() Returns the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.
void	setName(String name) Sets the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.
void	setPropertiesFromInterface(TextLocator castFrom)

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

equals, getPath, hashCode, setPath, setPropertiesFromInterface

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, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getPath, setPath

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

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

Methods inherited from interface tv.amwa.maj.entity.MAJCommon

equals, hashCode, toString

Constructor Detail

TextLocator

public TextLocator(@AAFString
                   String name)
            throws NullPointerException

Creates and initializes a new text locator, which provides information to help find a file containing the essence or to help find the physical media.

Parameters:

name - Text string containing information to help find the file containing the essence or the physical media.

Throws:

NullPointerException - Location of the media is null.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(TextLocator castFrom)

See Also:

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

getName

@AAFProperty(uuid1=17039618,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Name",
             typeName="String",
             optional=false,
             uniqueIdentifier=false,
             pid=16641)
public String getName()

Description copied from interface: TextLocator

Returns the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.

Specified by:

getName in interface TextLocator

Returns:

Name property of the text locator.

See Also:

Locator.getPath()

setName

public void setName(String name)
             throws NullPointerException

Description copied from interface: TextLocator

Sets the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.

Specified by:

setName in interface TextLocator

Parameters:

name - Name property of the text locator.

Throws:

NullPointerException - The given name is null.

See Also:

Locator.setPath(String)

clone

public TextLocator clone()

Description copied from interface: MAJCommon

Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.

This method does not throw a CloneNotSupportedException as all entity values must implement the Cloneable interface. If a cloning error does occur, a null value will be returned but this is very unlikely to happen.

Specified by:

clone in interface MAJCommon

Overrides:

clone in class Locator

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

appendXMLChildren

public final 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 Locator

Parameters:

parent - XML parent element to append child nodes to.