bbc.rd.tvanytime
Class BasicDescription

java.lang.Object
  extended by bbc.rd.tvanytime.BasicDescription

public class BasicDescription
extends java.lang.Object

BasicDescsription: Represents a TV-Anytime BasicDescription object.

Version:
1.0
Author:
Chris Akanbi, BBC Research & Development, April 2002

Constructor Summary
BasicDescription()
          Default constructor for objects of class BasicDescription
BasicDescription(Title title)
          Constructor for objects of class BasicDescription
 
Method Summary
 void addCaptionLanguage(CaptionLanguage captionLanguage)
          addCaptionLanguage - adds a CaptionLanguage object to the Description object
 void addGenre(Genre genre)
          addGenre - add a Genre object to this BasicDescription object
 void addKeyword(Keyword keyword)
          Add Keyword object to this program.
 void addPromotionalInformation(PromotionalInformation promotionalInformation)
          addPromotionalInformation - adds a PromotionalInformation object to the Description object
 void addRelatedMaterial(RelatedMaterial relatedMaterial)
          addRelatedMaterial - adds a RelatedMaterial object to the Description object
 void addSignLanguage(SignLanguage signLanguage)
          addSignLanguage - adds a SignLanguage 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.
 CaptionLanguage getCaptionLanguage(int index)
          getCaptionLanguage - gets the CaptionLanguage object at the specified index
 CreditsList getCreditsList()
          Returns the CreditsList.
 Genre getGenre(int index)
          getGenre - returns the Genre object at the specified index
 Keyword getKeyword(int index)
          Get Keyword object for this program.
 int getNumCaptionLanguages()
          getNumCaptionLanguages - gets the number of CaptionLanguage objects belonging to this Description object
 int getNumGenres()
          getNumGenres - returns the number of Genre objects in this BasicDescription object
 int getNumKeywords()
          Get number of Keyword objects contained in this program.
 int getNumPromotionalInformations()
          getNumPromotionalInformations - gets the number of PromotionalInformation objects belonging to this Description object
 int getNumRelatedMaterials()
          getNumRelatedMaterials - gets the number of RelatedMaterial objects belonging to this Description object
 int getNumSignLanguages()
          getNumSignLanguages - gets the number of SignLanguage 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
 PromotionalInformation getPromotionalInformation(int index)
          getPromotionalInformation - gets the PromotionalInformation object at the specified index
 RelatedMaterial getRelatedMaterial(int index)
          getRelatedMaterial - gets the RelatedMaterial object at the specified index
 SignLanguage getSignLanguage(int index)
          getSignLanguage - gets the SignLanguage 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, Keyword and Genre objects from this Description object.
 void removeCaptionLanguage(int index)
          removeCaptionLanguage - Removes a CaptionLanguage object from the Description object
 void removeGenre(int index)
          removeGenre - Removes a Genre object from the Description object
 void removeKeyword(int index)
          Removes a Keyword object from the Description object
 void removePromotionalInformation(int index)
          removePromotionalInformation - Removes a PromotionalInformation object from the Description object
 void removeRelatedMaterial(int index)
          removeRelatedMaterial - Removes a RelatedMaterial object from the Description object
 void removeSignLanguage(int index)
          removeSignLanguage - Removes a SignLanguage object from the Description object
 void removeSynopsis(int index)
          removeSynopsis - Removes a Synopsis object to the Description object
 void removeTitle(int index)
          removeTitle - Removes a Title object to the Description object
 void setCreditsList(CreditsList creditsList)
          Sets the CreditsList.
 java.lang.String toString(int indent)
          toString - returns a String representation of this BasicDescription object with the specified number of tab indentations
 java.lang.String toXML(int indent)
          Returns a XML representation of this BasicDescription 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

BasicDescription

public BasicDescription(Title title)
Constructor for objects of class BasicDescription

Parameters:
title - the title object

BasicDescription

public BasicDescription()
Default constructor for objects of class BasicDescription

Method Detail

toXML

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

Returns:
the XML representation of the BasicDescription object

toString

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

Returns:
the String representation of the BasicDescription 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

removeTitle

public void removeTitle(int index)
removeTitle - Removes a Title object to the Description object

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

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

removeSynopsis

public void removeSynopsis(int index)
removeSynopsis - Removes a Synopsis object to 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

removeRelatedMaterial

public void removeRelatedMaterial(int index)
removeRelatedMaterial - Removes a RelatedMaterial object from the Description object

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

getNumCaptionLanguages

public int getNumCaptionLanguages()
getNumCaptionLanguages - gets the number of CaptionLanguage objects belonging to this Description object

Returns:
the number of CaptionLanguage objects in this Description object

getCaptionLanguage

public CaptionLanguage getCaptionLanguage(int index)
getCaptionLanguage - gets the CaptionLanguage object at the specified index

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

addCaptionLanguage

public void addCaptionLanguage(CaptionLanguage captionLanguage)
addCaptionLanguage - adds a CaptionLanguage object to the Description object

Parameters:
title - the CaptionLanguage object

removeCaptionLanguage

public void removeCaptionLanguage(int index)
removeCaptionLanguage - Removes a CaptionLanguage object from the Description object

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

getNumSignLanguages

public int getNumSignLanguages()
getNumSignLanguages - gets the number of SignLanguage objects belonging to this Description object

Returns:
the number of SignLanguage objects in this Description object

getSignLanguage

public SignLanguage getSignLanguage(int index)
getSignLanguage - gets the SignLanguage object at the specified index

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

addSignLanguage

public void addSignLanguage(SignLanguage signLanguage)
addSignLanguage - adds a SignLanguage object to the Description object

Parameters:
signLanguage - the SignLanguage object

removeSignLanguage

public void removeSignLanguage(int index)
removeSignLanguage - Removes a SignLanguage object from the Description object

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

getNumPromotionalInformations

public int getNumPromotionalInformations()
getNumPromotionalInformations - gets the number of PromotionalInformation objects belonging to this Description object

Returns:
the number of PromotionalInformation objects in this Description object

getPromotionalInformation

public PromotionalInformation getPromotionalInformation(int index)
getPromotionalInformation - gets the PromotionalInformation object at the specified index

Parameters:
index - the index of the required PromotionalInformation object
Returns:
the CaptionLanguage object at the specified index

addPromotionalInformation

public void addPromotionalInformation(PromotionalInformation promotionalInformation)
addPromotionalInformation - adds a PromotionalInformation object to the Description object

Parameters:
PromotionalInformation - the PromotionalInformation object

removePromotionalInformation

public void removePromotionalInformation(int index)
removePromotionalInformation - Removes a PromotionalInformation object from the Description object

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

addGenre

public void addGenre(Genre genre)
addGenre - add a Genre object to this BasicDescription object

Parameters:
genre - the Genre object to be added

removeGenre

public void removeGenre(int index)
removeGenre - Removes a Genre object from the Description object

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

getNumGenres

public int getNumGenres()
getNumGenres - returns the number of Genre objects in this BasicDescription object

Returns:
the number of Genre objects in this BasicDescription object

getGenre

public Genre getGenre(int index)
getGenre - returns the Genre object at the specified index

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

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.

getCreditsList

public CreditsList getCreditsList()
Returns the CreditsList.

Returns:
The credits list.

setCreditsList

public void setCreditsList(CreditsList creditsList)
Sets the CreditsList.

Parameters:
creditsList - The credits list.

removeAll

public void removeAll()
removeAll - removes all Title, Synopsis, RelatedMaterial, CaptionLanguage, SignLanguage, PromotionalInformation, Keyword 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.