javax.microedition.broadcast.esg
Interface MetadataSet

All Known Implementing Classes:

CommonMetadataSet

public interface MetadataSet

MetadataSet is the interface which specifies a collection of metadata applicable to program event, service, service component and purchase objects. These metadata are usually defined in a public standards e.g. OMA BCAST, "IP Datacast over DVB-H", DMB, etc.

Metadata are described as attributes. Attributes are typed. The different types are:

• StringAttribute
• NumericAttribute
• BooleanAttribute
• DateAttribute
• ObjectAttribute

For example, some special flag in a certain broadcast specifications is of type boolean. It will have a definition similar to the following:

 static final BooleanAttribute SOME_FLAG = new BooleanAttribute("someflag"); 
 

To use this attribute in the context of a ProgramEvent:

 if (programEvent.getBooleanValue(SomeList.SOME_FLAG)) ...
 

Implementations of MetadataSet specialize to define the specific attributes applicable to ServiceGuideData per different broadcast specs.

See Also:

ServiceGuideData, Service, ServiceComponent, PurchaseObject

Method Summary

java.lang.String	getDescription() Get a description of this metadata set.
Attribute[]	getValidAttributes() Get all the available attributes defined in a particular broadcast specs.
Attribute[]	getValidProgramAttributes() Get all the available program attributes in this metadata set.
Attribute[]	getValidPurchaseAttributes() Get all the available purchase attributes in this metadata set.
Attribute[]	getValidServiceAttributes() Get all the available service attributes in this metadata set.
Attribute[]	getValidServiceComponentAttributes() Get all the available service component attributes in this metadata set.

Method Detail

getDescription

java.lang.String getDescription()

Get a description of this metadata set. The description should identify the name of the metadata specification, its version, etc.

Returns:

A description of this metadata set. The returned description cannot be null or an empty string.

getValidAttributes

Attribute[] getValidAttributes()

Get all the available attributes defined in a particular broadcast specs. The list of attributes returned must not be null or empty.

Returns:

The list of all available attributes. The list must contain at least one attribute.

getValidProgramAttributes

Attribute[] getValidProgramAttributes()

Get all the available program attributes in this metadata set.

Returns:

The list of all program attributes in this metadata set.

getValidPurchaseAttributes

Attribute[] getValidPurchaseAttributes()

Get all the available purchase attributes in this metadata set.

Returns:

The list of all purchase attributes in this metadata set.

getValidServiceAttributes

Attribute[] getValidServiceAttributes()

Get all the available service attributes in this metadata set.

Returns:

The list of all service attributes in this metadata set.

getValidServiceComponentAttributes

Attribute[] getValidServiceComponentAttributes()

Get all the available service component attributes in this metadata set.

Returns:

The list of all service component attributes in this metadata set.