bbc.rd.tvanytime
Class RelatedMaterial

java.lang.Object
  bbc.rd.tvanytime.RelatedMaterial

All Implemented Interfaces:

java.lang.Cloneable

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

RelatedMaterial: Represents a RelatedMaterial object.

Version:

1.0

Author:

Tim Sargeant, BBC Research & Development, September 2002 Modified Tristan Ferne, March 2005

Constructor Summary

RelatedMaterial()
Constructor for objects of type RelatedMaterial

RelatedMaterial(MPEG7MediaLocator locator)
Constructor for objects of type RelatedMaterial with required fields

RelatedMaterial(SegmentReference segmentReference)
Constructor for objects of type RelatedMaterial with required fields

Method Summary

java.lang.Object	clone() Clones itself.
java.lang.String	getHowRelated() Gets the HowRelated value.
java.lang.String	getHowRelatedHREF() Gets the HowRelated CS field.
MPEG7MediaLocator	getMediaLocator() Return the MediaLocator for this RelatedMaterial object.
java.lang.String	getName() Get the Name for the HowRelated item.
java.lang.String	getPromotionalText() Return the PromotionalText for this RelatedMaterial object.
SegmentReference	getSegmentReference() Return the SegmentReference for this RelatedMaterial object.
MPEG7MediaLocator	getSourceMediaLocator() Return the MediaLocator for this RelatedMaterial object.
void	setHowRelated(java.lang.String howRelated) Sets the HowRelated value.
void	setHowRelatedHREF(java.lang.String howRelatedHREF) Sets the HowRelated CS field.
void	setMediaLocator(MPEG7MediaLocator locator) Set the MediaLocator for this RelatedMaterial object.
void	setName(java.lang.String name) Set the Name for the HowRelated item.
void	setPromotionalText(java.lang.String promotionalText) Set the PromotionalText for this RelatedMaterial object.
void	setSegmentReference(SegmentReference segmentReference) Set the SegmentReference for this RelatedMaterial object.
void	setSourceMediaLocator(MPEG7MediaLocator sourceLocator) Set the SourceMediaLocator for this RelatedMaterial object.
java.lang.String	toString() Return a string representation of this object.
java.lang.String	toString(int indent) Return a string representation of this object.
java.lang.String	toXML() Return a XML representation of this object.
java.lang.String	toXML(int indent) Return a XML representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedMaterial

public RelatedMaterial()

Constructor for objects of type RelatedMaterial

RelatedMaterial

public RelatedMaterial(MPEG7MediaLocator locator)

Constructor for objects of type RelatedMaterial with required fields

Parameters:

locator - the MediaLocator for this related material.

RelatedMaterial

public RelatedMaterial(SegmentReference segmentReference)

Constructor for objects of type RelatedMaterial with required fields

Parameters:

segmentReference - the SegmentReference for this related material.

Method Detail

setMediaLocator

public void setMediaLocator(MPEG7MediaLocator locator)

Set the MediaLocator for this RelatedMaterial object.

Parameters:

locator - the MediaLocator for this related material.

setSegmentReference

public void setSegmentReference(SegmentReference segmentReference)

Set the SegmentReference for this RelatedMaterial object.

Parameters:

segmentReference - the SegmentReference for this related material.

getMediaLocator

public MPEG7MediaLocator getMediaLocator()

Return the MediaLocator for this RelatedMaterial object.

Returns:

MediaLocator for this RelatedMaterial object.

getSegmentReference

public SegmentReference getSegmentReference()

Return the SegmentReference for this RelatedMaterial object.

Returns:

SegmentReference for this RelatedMaterial object.

setSourceMediaLocator

public void setSourceMediaLocator(MPEG7MediaLocator sourceLocator)

Set the SourceMediaLocator for this RelatedMaterial object.

Parameters:

locator - The MediaLocator for the source content, to which this related material is attached.

getSourceMediaLocator

public MPEG7MediaLocator getSourceMediaLocator()

Return the MediaLocator for this RelatedMaterial object.

Returns:

The MediaLocator for the source content, to which this related material is attached.

setPromotionalText

public void setPromotionalText(java.lang.String promotionalText)

Set the PromotionalText for this RelatedMaterial object.

Parameters:

promotionalText - Additional information about the link, which can be used as an additional attractor.

getPromotionalText

public java.lang.String getPromotionalText()

Return the PromotionalText for this RelatedMaterial object.

Returns:

Additional information about the link, which can be used as an additional attractor.

setHowRelatedHREF

public void setHowRelatedHREF(java.lang.String howRelatedHREF)
                       throws TVAnytimeException

Sets the HowRelated CS field. This specifies the nature of the relationship between the described AV content and the related media assets. This is a CS of the form: "urn:tva:metadata:cs:HowRelatedCS:2002:x"

Parameters:

howRelated - The CS HREF.

Throws:

TVAnytimeException - if the href string is invalid.

getHowRelatedHREF

public java.lang.String getHowRelatedHREF()

Gets the HowRelated CS field. This specifies the nature of the relationship between the described AV content and the related media assets. This is a CS of the form: "urn:tva:metadata:cs:HowRelatedCS:2002:x"

setHowRelated

public void setHowRelated(java.lang.String howRelated)
                   throws TVAnytimeException

Sets the HowRelated value. Specifies the nature of the relationship between the described AV content and the related media assets. This is the final numerical value of the CS.

Throws:

TVAnytimeException

getHowRelated

public java.lang.String getHowRelated()

Gets the HowRelated value. Specifies the nature of the relationship between the described AV content and the related media assets. This is the final numerical value of the CS.

setName

public void setName(java.lang.String name)

Set the Name for the HowRelated item.

Parameters:

name - The name.

getName

public java.lang.String getName()

Get the Name for the HowRelated item.

Returns:

The name.

toXML

public java.lang.String toXML()

Return a XML representation of this object.

Returns:

XML representation of this object.

toXML

public java.lang.String toXML(int indent)

Return a XML representation of this object.

Parameters:

indent - number of tabs to put before the string.

Returns:

XML representation of this object.

toString

public java.lang.String toString()

Return a 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)

Return a 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.