bbc.rd.tvanytime.contentReferencing
Class Locator

java.lang.Object
  extended by bbc.rd.tvanytime.contentReferencing.Locator
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Locator
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Locator: A TVAnytime Locator object. This is a generic Locator object. The bbc.rd.tvanytime.util package contains a utility class offering various useful methods on DVB locators.

Version:
1.0 Modified T.Ferne 20/9/04
Author:
Tim Sargeant, BBC Research & Development, May 2003
See Also:
Serialized Form

Constructor Summary
Locator()
          Default Constructor for objects of type Locator.
Locator(java.lang.String locator)
          Constructor for objects of type Locator.
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 InstanceMetadataId getInstanceMetadataId()
          Get the InstanceMetadataId.
 java.lang.String getLocator()
          gets the locator as a String
 void setInstanceMetadataId(InstanceMetadataId imi)
          Set the InstanceMetadataId of this ScheduleEvent.
 void setLocator(java.lang.String locator)
          sets the locator
 java.lang.String toString()
          Returns string representation of this object.
 java.lang.String toString(int indent)
          Returns string representation of this object.
 java.lang.String toXML()
          Returns XML representation of this object.
 java.lang.String toXML(int indent)
          Returns XML representation of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Locator

public Locator()
Default Constructor for objects of type Locator.


Locator

public Locator(java.lang.String locator)
Constructor for objects of type Locator.

Method Detail

setLocator

public void setLocator(java.lang.String locator)
sets the locator


getLocator

public java.lang.String getLocator()
gets the locator as a String


getInstanceMetadataId

public InstanceMetadataId getInstanceMetadataId()
Get the InstanceMetadataId.

Returns:
InstanceMetadataId, or null if not set

setInstanceMetadataId

public void setInstanceMetadataId(InstanceMetadataId imi)
Set the InstanceMetadataId of this ScheduleEvent.

Parameters:
imi - An InstanceMetadataId object

toXML

public java.lang.String toXML()
Returns XML representation of this object.

Returns:
XML representation of this object.

toXML

public java.lang.String toXML(int indent)
Returns XML representation of this object.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
XML representation of the object.

toString

public java.lang.String toString()
Returns string representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
String representation of this object.

toString

public java.lang.String toString(int indent)
Returns string representation of this object.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
string representation of the object.

clone

public java.lang.Object clone()
Clones itself.

Overrides:
clone in class java.lang.Object
Returns:
A copy of itself.