|
Copyright 2008 Motorola Inc. and Nokia Corporation. All Rights Reserved. Specification License |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.microedition.broadcast.esg.CommonMetadataSet
public final class CommonMetadataSet
CommonMetadataSet
specifies an encompassing list of attributes that are
applicable across different platform, bearer and operator specifications.
For completeness, this list had been validated against the ESG specifications
from DVB-CBMS V.13 and OMA-BCAST V.1. The detail mappings from the JSR to the
aforementioned specifications are described in the
DVB-CBMSv13, OMA-BCASTv1, JSR272 ESG attributes mappings:
Open Document Spreadsheet version,
Microsoft Excel version.
All JSR-272 implementations MUST support CommonMetadataSet
. i.e.
ServiceGuide.getSupportedMetadataSets()
will
return at least CommonMetadataSet
.
Static getInstance()
method can be used to access CommonMetadataSet
directly without need to query the list of MetadataSet
s from the ServiceGuide
.
Attributes prefixed with "PROGRAM_" refer to ProgramEvents,
attributes prefixed with "SERVICE_COMPONENT_" refer to ServiceComponents,
attributes prefixed with "PURCHASE_" refer to purchasing and
the rest refer to Services. Table below shows which Attribute types can be used to query information
from classes implementing ServiceGuideData
.
In the table, "Yes" means that the Attribute
type can be used to query data from given
type of ServiceGuideData
interface whereas "No" means that it can't.
Attribute | ProgramEvent | PurchaseObject | Service | ServiceComponent |
PROGRAM_* | Yes | Yes | Yes | Yes |
PURCHASE_* | Yes | Yes | Yes | No |
SERVICE_* | Yes | Yes | Yes | Yes |
SERVICE_COMPONENT_* | Yes | No | Yes | Yes |
Following incomplete piece of code gives an example.
Technically, the code above works fine and most of time the result probably is as expected. However, the order of the of the values returned from get value methods is unspecified. Therefore, the code below is safer, for instance, to create a list of program names and their starting times.Services[] services = ServiceGuide.findServices(someQuery); String sid = s[0].getStringValue(CommonMetadataSet.SERVICE_ID); String[] names = s[0].getStringValues(CommonMetadataSet.PROGRAM_NAME); Date[] startTimes = s[0].getDateValues(CommonMetadataSet.PROGRAM_START_TIME);
Services[] services = ServiceGuide.findServices(someQuery); ProgramEvent programs = s[0].getPrograms(); for (int i = 0; i < programs.length; i++) { String name = programs[i].getStringValue(CommonMetadataSet.PROGRAM_NAME); Date startTime = programs[i].getDateValue(CommonMetadataSet.PROGRAM_START_TIME; // do something with the information ... }
Detailed description about the use of Attributes in queries is in
Unless otherwise noted, all attributes can return zero, one or more
associated values. However, a valid
URI Syntax and Semantics
The ESG may specify URIs of various broadcast auxiliary data;
e.g. SERVICE_REL_MATERIAL, SERVICE_AUX_LOGO, PROGRAM_CONTENT_AUX_SOUND etc.
These URIs can be of different types, for example:
ServiceGuide
documentation.
CommonMetadataSet
must not return zero
values for all attributes. At least one value must be returned for some attribute.
ServiceGuideData
provides two different versions of methods
to access either one (default) or multiple values.
See ServiceGuideData.
The URI syntax for Service, Programs and various related data are not defined
in this specification. They are broadcast/transport bearer dependent. Applications
that target to be bearer independent should reference the ESG attributes and
not rely on the specific URI syntax.
An
InputConnection
can be created from these URIs using the
Generic Connection Framework (javax.microedition.io.Connector
).
See auxiliary data example.
Genres and Ratings
The different genres and ratings are not defined in this specification.
They are broadcast specification dependent. For example,
TV-Anytime's metadata specification defines an
extensive list of genres (ContentCS) and ratings (IntendedAudienceCS) that are adopted
by other broadcast specifications like DVB.
It is possible to use the API to query for all applicable values for genres and ratings by
using ServiceGuide.getAllUniqueValues()
.
Field Summary | |
---|---|
static StringAttribute |
PROGRAM_CONTENT_AUX_CLIP
Reports the content's clip data defined as a URI reference. |
static StringAttribute |
PROGRAM_CONTENT_AUX_LOGO
Reports the Content's logo data defined as a URI reference. |
static StringAttribute |
PROGRAM_CONTENT_AUX_SOUND
Reports the Content's sound data defined as a URI reference. |
static StringAttribute |
PROGRAM_CONTENT_DESCRIPTION
Reports the content description. |
static StringAttribute |
PROGRAM_CONTENT_GENRE
Reports the content name. |
static StringAttribute |
PROGRAM_CONTENT_ID
Reports the content id as a URI reference. |
static StringAttribute |
PROGRAM_CONTENT_LOCATION
Reports the URIs for filecast services. |
static StringAttribute |
PROGRAM_CONTENT_NAME
Reports the content name. |
static StringAttribute |
PROGRAM_CONTENT_PARENTAL_RATING
Reports the content's parental rating. |
static StringAttribute |
PROGRAM_CONTENT_TYPE
Reports the content type as conformed to the MIME types defined in RFC 2046. |
static StringAttribute |
PROGRAM_DESCRIPTION
Reports the program description. |
static DateAttribute |
PROGRAM_DIST_END
Reports the end time at which the referenced content is delivered. |
static DateAttribute |
PROGRAM_DIST_START
Reports the start time at which the referenced content is available for delivery. |
static DateAttribute |
PROGRAM_END_TIME
Reports the Program's presentation end time. |
static StringAttribute |
PROGRAM_ID
Reports the Program ID represented as an URI. |
static BooleanAttribute |
PROGRAM_IS_FREE
Reports if the program is free. |
static BooleanAttribute |
PROGRAM_IS_PROTECTED
Reports if the program is scrambled. |
static StringAttribute |
PROGRAM_NAME
Reports the name of the ProgramEvent |
static StringAttribute |
PROGRAM_REL_MATERIAL
Reports the URI reference to the Program's related material. |
static DateAttribute |
PROGRAM_START_TIME
Reports the Program's presentation start time. |
static StringAttribute |
PURCHASE_AUX_CLIP
Reports the purchase clip data defined as a URI reference. |
static StringAttribute |
PURCHASE_AUX_LOGO
Reports the purchase logo data defined as a URI reference. |
static StringAttribute |
PURCHASE_AUX_SOUND
Reports the purchase sound data defined as a URI reference. |
static StringAttribute |
PURCHASE_CHANNEL_CONTACT
Reports the URI of the purchase channel contact. |
static StringAttribute |
PURCHASE_CHANNEL_DESCRIPTION
Reports the purchase channel description. |
static StringAttribute |
PURCHASE_CHANNEL_ID
Reports the purchase channel ID. |
static StringAttribute |
PURCHASE_CHANNEL_NAME
Reports the purchase channel name. |
static StringAttribute |
PURCHASE_CHANNEL_PORTAL
Reports the URI of the purchase channel portal. |
static StringAttribute |
PURCHASE_CURRENCY
Reports the purchase currency. |
static StringAttribute |
PURCHASE_DESCRIPTION
Reports the purchase description. |
static StringAttribute |
PURCHASE_ID
Reports the purchase ID. |
static StringAttribute |
PURCHASE_ITEM_DESCRIPTION
Reports the description of the purchase item. |
static StringAttribute |
PURCHASE_ITEM_ID
Reports the purchase item ID. |
static StringAttribute |
PURCHASE_ITEM_NAME
The name of the PurchaseItem or service bundle |
static StringAttribute |
PURCHASE_ITEM_PARENTAL_RATING
Reports the purchase item's parental rating. |
static StringAttribute |
PURCHASE_ITEM_REL_MATERIAL
Reports the URI reference to the purchase item's related material. |
static StringAttribute |
PURCHASE_PRICE
Reports the purchase price. |
static DateAttribute |
PURCHASE_VALID_FROM
Reports the time after when the purchase is valid. |
static DateAttribute |
PURCHASE_VALID_TO
Reports the time before when the purchase is valid. |
static StringAttribute |
SERVICE_AUX_CLIP
Reports the Service's media data that are embedded inside the ESG. |
static StringAttribute |
SERVICE_AUX_LOGO
Reports the Service's auxiliary logo data defined as an URI reference. |
static StringAttribute |
SERVICE_AUX_SOUND
Reports the reference to Service's auxiliary sound data. |
static StringAttribute |
SERVICE_COMPONENT_ACCESS_APP_TYPE
Specifies the content type from which the terminal can determine the consuming application of the service. |
static StringAttribute |
SERVICE_COMPONENT_ACCESS_ID
Reports the acquisition ID defined as a URI reference. |
static StringAttribute |
SERVICE_COMPONENT_AUD_LANG
Reports the language of service component for audio track. |
static NumericAttribute |
SERVICE_COMPONENT_AVERAGE_AUD_RATE
Reports the average audio bit rate in bits per second. |
static NumericAttribute |
SERVICE_COMPONENT_AVERAGE_VID_RATE
Reports the average video bit rate in bits per second. |
static StringAttribute |
SERVICE_COMPONENT_CLOSED_CAPTIONS_LANG
Reports the language of service component for closed captions subtitles. |
static StringAttribute |
SERVICE_COMPONENT_DOWNLOAD_FILE_FORMAT
Reports the mime type of the download file . |
static StringAttribute |
SERVICE_COMPONENT_KEY_MANAG_SYS
Reports the name of the key management system. |
static StringAttribute |
SERVICE_COMPONENT_LANGUAGE
Reports the language used for a service component. |
static NumericAttribute |
SERVICE_COMPONENT_MAX_AUD_RATE
Reports the maximum audio bit rate in bits per second. |
static NumericAttribute |
SERVICE_COMPONENT_MAX_VID_RATE
Reports the maximum video bit rate in bits per second. |
static StringAttribute |
SERVICE_COMPONENT_MIME_TYPE
Reports the MIME type of a service component. |
static StringAttribute |
SERVICE_COMPONENT_SDP_REF
Reports the URI to the SDP file. |
static StringAttribute |
SERVICE_COMPONENT_SDP_STREAM
Reports the session parameters to access a SDP stream. |
static StringAttribute |
SERVICE_COMPONENT_SDP_STRING
Reports the SDP data defined inlined in the ESG. |
static StringAttribute |
SERVICE_COMPONENT_VID_OPEN_CAPTIONS_LANG
Reports the language of service component for open captions subtitles. |
static StringAttribute |
SERVICE_COMPONENT_VID_SIGN_LANG
Reports the language of service component for signed video language. |
static StringAttribute |
SERVICE_DESCRIPTION
Reports the Service Description. |
static StringAttribute |
SERVICE_GENRE
Reports the Service's genre. |
static StringAttribute |
SERVICE_ID
Reports the Service ID represented as a URI. |
static BooleanAttribute |
SERVICE_IS_FREE
Reports if the Service is free. |
static BooleanAttribute |
SERVICE_IS_PROTECTED
Reports if the Service is protected. |
static StringAttribute |
SERVICE_NAME
Reports the Service/Channel Name. |
static StringAttribute |
SERVICE_PARENTAL_RATING
Reports the Service's parental rating. |
static StringAttribute |
SERVICE_REL_MATERIAL
Reports the Service related material. |
static StringAttribute |
SERVICE_TYPE
Reports the Service's type. |
static StringAttribute |
SERVICE_TYPE_NAME
Reports the common name for the Service type. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Get a description of the metadata set. |
static CommonMetadataSet |
getInstance()
Get CommonMetadataSet instance. |
Attribute[] |
getValidAttributes()
Get all the static final attributes defined in CommonMetadataSet . |
Attribute[] |
getValidProgramAttributes()
Get all the static final program attributes defined in CommonMetadataSet . |
Attribute[] |
getValidPurchaseAttributes()
Get all the static final purchase attributes defined in CommonMetadataSet . |
Attribute[] |
getValidServiceAttributes()
Get all the static final service attributes defined in CommonMetadataSet . |
Attribute[] |
getValidServiceComponentAttributes()
Get all the static final service component attributes defined in CommonMetadataSet . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final StringAttribute PROGRAM_CONTENT_AUX_CLIP
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PROGRAM_CONTENT_AUX_LOGO
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PROGRAM_CONTENT_AUX_SOUND
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PROGRAM_CONTENT_DESCRIPTION
public static final StringAttribute PROGRAM_CONTENT_GENRE
public static final StringAttribute PROGRAM_CONTENT_ID
public static final StringAttribute PROGRAM_CONTENT_LOCATION
javax.microedition.io.Connector
to receive the filecast contents.
public static final StringAttribute PROGRAM_CONTENT_NAME
public static final StringAttribute PROGRAM_CONTENT_PARENTAL_RATING
public static final StringAttribute PROGRAM_CONTENT_TYPE
public static final StringAttribute PROGRAM_DESCRIPTION
public static final DateAttribute PROGRAM_DIST_END
public static final DateAttribute PROGRAM_DIST_START
public static final DateAttribute PROGRAM_END_TIME
public static final StringAttribute PROGRAM_ID
public static final BooleanAttribute PROGRAM_IS_FREE
public static final BooleanAttribute PROGRAM_IS_PROTECTED
public static final StringAttribute PROGRAM_NAME
public static final StringAttribute PROGRAM_REL_MATERIAL
public static final DateAttribute PROGRAM_START_TIME
public static final StringAttribute PURCHASE_AUX_CLIP
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PURCHASE_AUX_LOGO
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PURCHASE_AUX_SOUND
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute PURCHASE_CHANNEL_CONTACT
public static final StringAttribute PURCHASE_CHANNEL_DESCRIPTION
public static final StringAttribute PURCHASE_CHANNEL_ID
public static final StringAttribute PURCHASE_CHANNEL_NAME
public static final StringAttribute PURCHASE_CHANNEL_PORTAL
public static final StringAttribute PURCHASE_CURRENCY
public static final StringAttribute PURCHASE_DESCRIPTION
public static final StringAttribute PURCHASE_ID
public static final StringAttribute PURCHASE_ITEM_DESCRIPTION
public static final StringAttribute PURCHASE_ITEM_ID
public static final StringAttribute PURCHASE_ITEM_NAME
public static final StringAttribute PURCHASE_ITEM_PARENTAL_RATING
public static final StringAttribute PURCHASE_ITEM_REL_MATERIAL
public static final StringAttribute PURCHASE_PRICE
public static final DateAttribute PURCHASE_VALID_FROM
public static final DateAttribute PURCHASE_VALID_TO
Long.MAX_LONG
from
Date.longValue()
.
This attribute can associate only 1 (or possibly 0) value.
public static final StringAttribute SERVICE_AUX_CLIP
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute SERVICE_AUX_LOGO
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute SERVICE_AUX_SOUND
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute SERVICE_COMPONENT_ACCESS_APP_TYPE
public static final StringAttribute SERVICE_COMPONENT_ACCESS_ID
public static final StringAttribute SERVICE_COMPONENT_AUD_LANG
public static final NumericAttribute SERVICE_COMPONENT_AVERAGE_AUD_RATE
integer
.
public static final NumericAttribute SERVICE_COMPONENT_AVERAGE_VID_RATE
integer
.
public static final StringAttribute SERVICE_COMPONENT_CLOSED_CAPTIONS_LANG
public static final StringAttribute SERVICE_COMPONENT_DOWNLOAD_FILE_FORMAT
public static final StringAttribute SERVICE_COMPONENT_KEY_MANAG_SYS
public static final StringAttribute SERVICE_COMPONENT_LANGUAGE
public static final NumericAttribute SERVICE_COMPONENT_MAX_AUD_RATE
integer
.
public static final NumericAttribute SERVICE_COMPONENT_MAX_VID_RATE
integer
.
public static final StringAttribute SERVICE_COMPONENT_MIME_TYPE
public static final StringAttribute SERVICE_COMPONENT_SDP_REF
public static final StringAttribute SERVICE_COMPONENT_SDP_STREAM
SERVICE_COMPONENT_SDP_REF
This attribute can associate only 1 (or possibly 0) value.
public static final StringAttribute SERVICE_COMPONENT_SDP_STRING
public static final StringAttribute SERVICE_COMPONENT_VID_OPEN_CAPTIONS_LANG
public static final StringAttribute SERVICE_COMPONENT_VID_SIGN_LANG
public static final StringAttribute SERVICE_DESCRIPTION
public static final StringAttribute SERVICE_GENRE
public static final StringAttribute SERVICE_ID
public static final BooleanAttribute SERVICE_IS_FREE
public static final BooleanAttribute SERVICE_IS_PROTECTED
public static final StringAttribute SERVICE_NAME
public static final StringAttribute SERVICE_PARENTAL_RATING
public static final StringAttribute SERVICE_REL_MATERIAL
javax.microedition.io.Connector
to retrieve the data.
public static final StringAttribute SERVICE_TYPE
public static final StringAttribute SERVICE_TYPE_NAME
Attribute
does not have a direct
mapping to any broadcast specification. It's purpose is to report JSR 272 specific name for the
service type to allow broadcast specification independent identification of the service type.
Possible types are
"tv"
, "radio"
and "data"
.
Method Detail |
---|
public java.lang.String getDescription()
getDescription
in interface MetadataSet
public static final CommonMetadataSet getInstance()
CommonMetadataSet
instance.
CommonMetadataSet
instance.public Attribute[] getValidAttributes()
CommonMetadataSet
.
getValidAttributes
in interface MetadataSet
CommonMetadataSet
.public Attribute[] getValidProgramAttributes()
CommonMetadataSet
.
getValidProgramAttributes
in interface MetadataSet
CommonMetadataSet
.public Attribute[] getValidPurchaseAttributes()
CommonMetadataSet
.
getValidPurchaseAttributes
in interface MetadataSet
CommonMetadataSet
.public Attribute[] getValidServiceAttributes()
CommonMetadataSet
.
getValidServiceAttributes
in interface MetadataSet
CommonMetadataSet
.public Attribute[] getValidServiceComponentAttributes()
CommonMetadataSet
.
getValidServiceComponentAttributes
in interface MetadataSet
CommonMetadataSet
.
|
Copyright 2008 Motorola Inc. and Nokia Corporation. All Rights Reserved. Specification License |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |