bbc.rd.tvanytime.groupInformation
Class GroupInformationTable

java.lang.Object
  extended by bbc.rd.tvanytime.groupInformation.GroupInformationTable
All Implemented Interfaces:
MetadataSearch, java.lang.Cloneable

public class GroupInformationTable
extends java.lang.Object
implements MetadataSearch, java.lang.Cloneable

GroupInformationTable: Represents a TV-Anytime Group Information Table

Version:
1.0 Modified T.Ferne, September 2004: Fixed hashtables and remove...() methods.
Author:
Chris Akanbi, BBC Research & Development, April 2002

Constructor Summary
GroupInformationTable()
          Constructor for objects of class GroupInformationTable
 
Method Summary
 void addGroupInformation(GroupInformation groupInformation)
          addGroupInformation - adds a GroupInformation object to this GroupInformationTable
 java.lang.Object clone()
          Clones itself.
 java.util.Vector getGroupInformation(ContentReference crid)
          Get group information for the specified CRID.
 GroupInformation getGroupInformation(int index)
          getGroupInformation - gets the GroupInformation object for this GroupInformationTable
 int getNumGroupInformations()
          getNumInformation- gets the number of GroupInformation objects belonging to this GroupInformationTable
 java.util.Vector getProgramInformation(ContentReference crid)
          Unsupported method - always throws exception.
 java.util.Vector getProgramLocation(ContentReference crid)
          Unsupported method - always throws exception.
 java.util.Vector getSegmentInformation(ContentReference crid)
          Unsupported method - always throws exception.
 void removeAll()
          removeAll - removes all GroupInformation objects
 void removeGroupInformation(ContentReference crid)
          Removes a GroupInformation object from this GroupInformationTable
 void removeGroupInformation(GroupInformation groupInformation)
          Removes a GroupInformation object from this GroupInformationTable
 void removeGroupInformation(int index)
          Removes a GroupInformation object from this GroupInformationTable
 java.lang.String toString()
          toString - returns a String representation of this GroupInformationTable
 java.lang.String toString(int indent)
          toString - returns a String representation of this GroupInformationTable with the specified number of tab indentations
 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

GroupInformationTable

public GroupInformationTable()
Constructor for objects of class GroupInformationTable

Method Detail

getProgramLocation

public java.util.Vector getProgramLocation(ContentReference crid)
                                    throws SearchInterfaceNotSupportedException
Unsupported method - always throws exception.

Specified by:
getProgramLocation in interface MetadataSearch
Parameters:
crid - the CRID of the ProgramLocation object to be searched for.
Returns:
Vector containing ProgramLocation objects. Empty if none found.
Throws:
SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getProgramInformation

public java.util.Vector getProgramInformation(ContentReference crid)
                                       throws SearchInterfaceNotSupportedException
Unsupported method - always throws exception.

Specified by:
getProgramInformation in interface MetadataSearch
Parameters:
crid - the CRID of the ProgramInformation object to be searched for.
Returns:
Vector containing ProgramInformation objects. Empty if none found.
Throws:
SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getSegmentInformation

public java.util.Vector getSegmentInformation(ContentReference crid)
                                       throws SearchInterfaceNotSupportedException
Unsupported method - always throws exception.

Specified by:
getSegmentInformation in interface MetadataSearch
Parameters:
crid - the CRID of the SegmentInformation object to be searched for.
Returns:
Vector containing SegmentInformation objects. Empty if none found.
Throws:
SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getGroupInformation

public java.util.Vector getGroupInformation(ContentReference crid)
                                     throws SearchInterfaceNotSupportedException
Get group information for the specified CRID.

Specified by:
getGroupInformation in interface MetadataSearch
Parameters:
crid - the CRID of the GroupInformation object to be searched for.
Returns:
Vector containing GroupInformation objects. Empty if none found.
Throws:
SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getNumGroupInformations

public int getNumGroupInformations()
getNumInformation- gets the number of GroupInformation objects belonging to this GroupInformationTable

Returns:
the number of GroupInformation objects in this GroupInformationTable

getGroupInformation

public GroupInformation getGroupInformation(int index)
getGroupInformation - gets the GroupInformation object for this GroupInformationTable

Parameters:
index - the index to the GroupInformation object
Returns:
the GroupInformation object

addGroupInformation

public void addGroupInformation(GroupInformation groupInformation)
addGroupInformation - adds a GroupInformation object to this GroupInformationTable

Parameters:
groupInformation - the GroupInformation object

removeGroupInformation

public void removeGroupInformation(int index)
Removes a GroupInformation object from this GroupInformationTable

Parameters:
index - The index to the GroupInformation object

removeGroupInformation

public void removeGroupInformation(GroupInformation groupInformation)
Removes a GroupInformation object from this GroupInformationTable

Parameters:
groupInformation - The GroupInformation object to remove

removeGroupInformation

public void removeGroupInformation(ContentReference crid)
Removes a GroupInformation object from this GroupInformationTable

Parameters:
crid - The CRID of the GroupInformation object to remove

toString

public java.lang.String toString()
toString - returns a String representation of this GroupInformationTable

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

toString

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

Returns:
String representation of this GroupInformationTable

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.

removeAll

public void removeAll()
removeAll - removes all GroupInformation objects


clone

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

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