tv.amwa.maj.iface
Interface Locator

All Superinterfaces:

InterchangeObject

All Known Subinterfaces:

NetworkLocator, TextLocator

All Known Implementing Classes:

Locator, NetworkLocator, TextLocator

public interface Locator
extends InterchangeObject

Specifies information to help find a file that contains the essence or to help find the physical media.

Author:

Richard Cartwright

See Also:

EssenceDescriptor.getLocators()

Method Summary

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

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

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

Method Detail

setPath

void setPath(@AAFString
             String path)
             throws NullPointerException

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.

Parameters:

path - Path string property of this locator.

Throws:

NullPointerException - The given path is null.

getPath

@AAFString
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.

Returns:

Path string property of this locator.