bbc.rd.tvanytime.segmentInformation
Class SegmentInformation

java.lang.Object
  extended by bbc.rd.tvanytime.segmentInformation.SegmentInformation
All Implemented Interfaces:
java.lang.Cloneable

public class SegmentInformation
extends java.lang.Object
implements java.lang.Cloneable

SegmentInformation: Represents a SegmentInformation object

Version:
1.0
Author:
Tim Sargeant, BBC Research & Development, April 2002

Constructor Summary
SegmentInformation()
          Constructor for objects of class SegmentInformation
SegmentInformation(java.lang.String segmentID, ContentReference programRef, SegmentLocator segmentLocator)
          Constructor for objects of class SegmentInformation with all required fields
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 BasicSegmentDescription getDescription()
          getDescription - gets the Description
 ContentReference getProgramRef()
          getProgramRef - gets the programRef
 java.lang.String getSegmentID()
          getSegmentID - gets the segmentID
 SegmentLocator getSegmentLocator()
          getSegmentLocator - gets the SegmentLocator
 void setDescription(BasicSegmentDescription description)
          setDescription - set the Description
 void setProgramRef(ContentReference programRef)
          setProgramRef - sets the programRef
 void setSegmentID(java.lang.String segmentID)
          setSegmentID - sets the segmentID
 void setSegmentLocator(SegmentLocator segmentLocator)
          setSegmentLocator - set the SegmentLocator
 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 table.
 java.lang.String toXML(int indent)
          Returns XML representation of this table.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SegmentInformation

public SegmentInformation()
Constructor for objects of class SegmentInformation


SegmentInformation

public SegmentInformation(java.lang.String segmentID,
                          ContentReference programRef,
                          SegmentLocator segmentLocator)
Constructor for objects of class SegmentInformation with all required fields

Parameters:
segmentID - the segment ID
programRef - a ContentReference object
segmentLocator - a SegmentLocator object
Method Detail

getDescription

public BasicSegmentDescription getDescription()
getDescription - gets the Description

Returns:
the BasicSegmentDescription object or null if it doesn't exist

setDescription

public void setDescription(BasicSegmentDescription description)
setDescription - set the Description

Parameters:
description - the BasicSegmentDescription object

getSegmentLocator

public SegmentLocator getSegmentLocator()
getSegmentLocator - gets the SegmentLocator

Returns:
the SegmentLocator object

setSegmentLocator

public void setSegmentLocator(SegmentLocator segmentLocator)
setSegmentLocator - set the SegmentLocator

Parameters:
segmentLocator - the SegmentLocator object

getSegmentID

public java.lang.String getSegmentID()
getSegmentID - gets the segmentID

Returns:
the segmentID

getProgramRef

public ContentReference getProgramRef()
getProgramRef - gets the programRef

Returns:
the programRef

setSegmentID

public void setSegmentID(java.lang.String segmentID)
setSegmentID - sets the segmentID

Parameters:
segmentID - the segmentID

setProgramRef

public void setProgramRef(ContentReference programRef)
setProgramRef - sets the programRef

Parameters:
programRef - the programRef (a ContentReference object)

toXML

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

Returns:
XML representation of this table.

toXML

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

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

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 to put before the string.
Returns:
string representation of this object.

clone

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

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