tv.amwa.maj.entity
Class NetworkLocator

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

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, InterchangeObject, Locator, NetworkLocator, XMLSerializable

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

Implements a representation of information to help find a file containing essence, using a uniform resource identifier (URI). The current URI specification is RFC 3986.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

NetworkLocator.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

NetworkLocator(String urlString)
Creates and initializes a new network locator, which provides information to help find a file containing essence.

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.
NetworkLocator	clone() Creates a cloned copy of this entity.
String	getURLString()
void	setPropertiesFromInterface(NetworkLocator castFrom)
void	setURLString(String urlString)

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

NetworkLocator

public NetworkLocator(@AAFString
                      String urlString)
               throws NullPointerException,
                      IllegalArgumentException

Creates and initializes a new network locator, which provides information to help find a file containing essence.

Parameters:

urlString - Absolute Uniform Resource Locator (URL) complying with RFC 1738 or relative Uniform Resource Identifier (URI) complying with RFC 2396 for file containing the essence. If it is a relative URI, the base URI is determined from the URI of the AAF persistent unit itself.

Throws:

NullPointerException - Location URL is null.

IllegalArgumentException - The given URI is not syntactically valid.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(NetworkLocator castFrom)

See Also:

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

getURLString

@AAFProperty(uuid1=16908545,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="URLString",
             typeName="String",
             optional=false,
             uniqueIdentifier=false,
             pid=16385)
public String getURLString()

setURLString

public void setURLString(String urlString)
                  throws NullPointerException,
                         IllegalArgumentException

Throws:

NullPointerException

IllegalArgumentException

clone

public NetworkLocator 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 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.