bbc.rd.tvanytime.programInformation
Class VideoAttributes

java.lang.Object
  bbc.rd.tvanytime.programInformation.VideoAttributes

All Implemented Interfaces:

java.lang.Cloneable

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

VideoAttributes: Represents technical video attributes of a program.

Version:

1.0

Author:

Tristan Ferne, BBC Research & Development, November 2002

Constructor Summary

VideoAttributes()
Create VideoAttributes object.

Method Summary

void	addAspectRatio(AspectRatio aspectRatio) Add an AspectRatio object to this VideoAttributes object.
java.lang.Object	clone() Clones itself.
AspectRatio	getAspectRatio(int index) getAspectRatio - returns the AspectRatio object at the specified index
int	getNumAspectRatios() getNumAspectRatios - returns the number of aspectRatio objects in this VideoAttributes object
void	removeAll() removeAll - removes all AspectRatio objects from this VideoAttributes object
void	removeAspectRatio(int index) Removes the AspectRatio object at the specified index
java.lang.String	toString() Returns string representation of the video attributes.
java.lang.String	toString(int indent) Returns string representation of the video attributes.
java.lang.String	toXML() Returns XML representation of the video attributes.
java.lang.String	toXML(int indent) Returns XML representation of the video attributes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoAttributes

public VideoAttributes()

Create VideoAttributes object.

Method Detail

addAspectRatio

public void addAspectRatio(AspectRatio aspectRatio)
                    throws TVAnytimeException

Add an AspectRatio object to this VideoAttributes object. Maximum of two allowed.

Parameters:

aspectRatio - the AspectRatio object to be added.

Throws:

TVAnytimeException

getNumAspectRatios

public int getNumAspectRatios()

getNumAspectRatios - returns the number of aspectRatio objects in this VideoAttributes object

Returns:

the number of AspectRatio objects in this VideoAttributes object

getAspectRatio

public AspectRatio getAspectRatio(int index)

getAspectRatio - returns the AspectRatio object at the specified index

Parameters:

index - the index of the required AspectRatio object

Returns:

the AspectRatio object at the specified index

removeAspectRatio

public void removeAspectRatio(int index)

Removes the AspectRatio object at the specified index

Parameters:

index - the index of the AspectRatio object to be removed

removeAll

public void removeAll()

removeAll - removes all AspectRatio objects from this VideoAttributes object

toXML

public java.lang.String toXML()

Returns XML representation of the video attributes.

Returns:

XML representation of the video attributes.

toXML

public java.lang.String toXML(int indent)

Returns XML representation of the video attributes.

Parameters:

indent - Number of tabs with which to indent the string.

Returns:

XML representation of the video attributes.

toString

public java.lang.String toString()

Returns string representation of the video attributes.

Overrides:

toString in class java.lang.Object

Returns:

string representation of the video attributes.

toString

public java.lang.String toString(int indent)

Returns string representation of the video attributes.

Parameters:

indent - Number of tabs with which to indent the string.

Returns:

string representation of the video attributes.

clone

public java.lang.Object clone()

Clones itself.

Overrides:

clone in class java.lang.Object

Returns:

A copy of itself.