bbc.rd.tvanytime.segmentInformation
Class BasicSegmentDescription

java.lang.Object
  extended by bbc.rd.tvanytime.segmentInformation.BasicSegmentDescription

public class BasicSegmentDescription
extends java.lang.Object

BasicSegmentDescription: Represents a TV-Anytime Description object.
This object is named 'Description' in the XML and appears in the SegmentationInformation table. It is of type 'BasicSegmentDescription'.

Version:
1.01
Author:
Tim Sargeant, BBC Research & Development, February 2003 Changes: Added support for Keywords

Constructor Summary
BasicSegmentDescription()
          Default constructor for objects of class BasicSegmentDescription
 
Method Summary
 void addKeyword(Keyword keyword)
          Add Keyword object to this program.
 void addRelatedMaterial(RelatedMaterial relatedMaterial)
          addRelatedMaterial - adds a RelatedMaterial object to the Description object
 void addSynopsis(Synopsis synopsis)
          addSynopsis - adds a Synopsis object to the Description object
 void addTitle(Title title)
          addTitle - adds a Title object to the Description object
 java.lang.Object clone()
          Clones itself.
 Keyword getKeyword(int index)
          Get Keyword object for this program.
 int getNumKeywords()
          Get number of Keyword objects contained in this program.
 int getNumRelatedMaterials()
          getNumRelatedMaterials - gets the number of RelatedMaterial objects belonging to this Description object
 int getNumSynopses()
          getNumSynopses - gets the number of Synopsis objects belonging to this Description object
 int getNumTitles()
          getNumTitles - gets the number of Title objects belonging to this Description object
 RelatedMaterial getRelatedMaterial(int index)
          getRelatedMaterial - gets the RelatedMaterial object at the specified index
 Synopsis getSynopsis(int index)
          getSynopsis - gets the Synopsis object at the specified index
 Title getTitle(int index)
          getTitle - gets the Title object at the specified index
 void removeAll()
          removeAll - removes all Title, Synopsis, RelatedMaterial, CaptionLanguage, SignLanguage, PromotionalInformation and Genre objects from this Description object.
 void removeKeyword(int index)
          Removes a Keyword object from the Description object
 java.lang.String toString(int indent)
          toString - returns a String representation of this BasicSegmentDescription object with the specified number of tab indentations
 java.lang.String toXML(int indent)
          Returns a XML representation of this BasicSegmentDescription object with the specified number of tab indentations
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicSegmentDescription

public BasicSegmentDescription()
Default constructor for objects of class BasicSegmentDescription

Method Detail

toXML

public java.lang.String toXML(int indent)
Returns a XML representation of this BasicSegmentDescription object with the specified number of tab indentations

Returns:
the XML representation of the BasicSegmentDescription object

toString

public java.lang.String toString(int indent)
toString - returns a String representation of this BasicSegmentDescription object with the specified number of tab indentations

Returns:
the String representation of the BasicSegmentDescription object

getNumTitles

public int getNumTitles()
getNumTitles - gets the number of Title objects belonging to this Description object

Returns:
the number of Title objects in this Description object

getTitle

public Title getTitle(int index)
getTitle - gets the Title object at the specified index

Parameters:
index - the index of the required Title object
Returns:
the Title object at the specified index

addTitle

public void addTitle(Title title)
addTitle - adds a Title object to the Description object

Parameters:
title - the Title object

getNumSynopses

public int getNumSynopses()
getNumSynopses - gets the number of Synopsis objects belonging to this Description object

Returns:
the number of Synopsis objects in this Description object

getSynopsis

public Synopsis getSynopsis(int index)
getSynopsis - gets the Synopsis object at the specified index

Parameters:
index - the index of the required Synopsis object
Returns:
the Synopsis object at the specified index

addSynopsis

public void addSynopsis(Synopsis synopsis)
addSynopsis - adds a Synopsis object to the Description object

Parameters:
synopsis - the Synopsis object

getNumKeywords

public int getNumKeywords()
Get number of Keyword objects contained in this program.

Returns:
Number of Keyword objects contained in this program.

getKeyword

public Keyword getKeyword(int index)
Get Keyword object for this program.

Parameters:
index - The index of the Keyword object to access.
Returns:
Specified Keyword object.

addKeyword

public void addKeyword(Keyword keyword)
Add Keyword object to this program.

Parameters:
memberOf - The Keyword object to add to this program.

removeKeyword

public void removeKeyword(int index)
Removes a Keyword object from the Description object

Parameters:
index - The index of the object to remove.

getNumRelatedMaterials

public int getNumRelatedMaterials()
getNumRelatedMaterials - gets the number of RelatedMaterial objects belonging to this Description object

Returns:
the number of RelatedMaterial objects in this Description object

getRelatedMaterial

public RelatedMaterial getRelatedMaterial(int index)
getRelatedMaterial - gets the RelatedMaterial object at the specified index

Parameters:
index - the index of the required RelatedMaterial object
Returns:
the RelatedMaterial object at the specified index

addRelatedMaterial

public void addRelatedMaterial(RelatedMaterial relatedMaterial)
addRelatedMaterial - adds a RelatedMaterial object to the Description object

Parameters:
relatedMaterial - the RelatedMaterial object

removeAll

public void removeAll()
removeAll - removes all Title, Synopsis, RelatedMaterial, CaptionLanguage, SignLanguage, PromotionalInformation and Genre objects from this Description object.


clone

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

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