Commit 4151b771 authored by wmunsil's avatar wmunsil

HN API changes called for by OCVET-101.

parent 8a6da6cd
/*
* Created on 29-Sep-2004
*
*/
package org.ocap.hn.content;
import java.util.Enumeration;
......@@ -55,10 +51,7 @@ public abstract class MetadataNode extends Object
}
/**
* Returns the Metadata for the specified key. The returned object
* can be a normal String (e.g. for title etc), a java.awt.Image, a Vector
* containing a list of elements, another MetadataNode for tree like
* metadata structures or other tbd. Objects. In order to query a Metadata
* Returns the Metadata for the specified key. In order to query a Metadata
* in a hierarchy query strings like<br>IDENT1#IDENT2#IDENT3 are possible
* where IDENT1 is a MetadataNode in this node, IDENT2 a MetadataNode in
* IDENT2 and IDENT3 an object in IDENT2. Performs a local cache search
......@@ -86,7 +79,6 @@ public abstract class MetadataNode extends Object
* addition, the following classes have a known network mapping:<br>
* org.dvb.application.AppID <br>
* org.ocap.storage.ExtendedFileAccessPermissions <br>
* org.ocap.hn.content.ContentContainer <br>
* org.ocap.hn.content.MetadataNode <br><br>
*
* If the Object to be added is an instance of MetadataNode, all Objects
......@@ -145,7 +137,6 @@ public abstract class MetadataNode extends Object
* addition, the following classes have a known network mapping:<br>
* org.dvb.application.AppID <br>
* org.ocap.storage.ExtendedFileAccessPermissions <br>
* org.ocap.hn.content.ContentContainer <br>
* org.ocap.hn.content.MetadataNode <br><br>
*
* If the Object to be added is an instance of MetadataNode, all Objects
......
......@@ -145,8 +145,7 @@ public interface UPnPConstants
* <p>
* The value of this field is <code>"upnp:album"</code>
* </p>
* <br> Queries for <code>ALBUM</code> should always return a String.
* <br>getMetadata() will return an array of Strings.
* <br>getMetadata() will return a String.
* @see MetadataNode#getMetadata(String)
*
*/
......@@ -176,13 +175,15 @@ public interface UPnPConstants
/**
* Reference to artist discography.
* <p>The value of this field is <code>"upnp:artistDiscographyURI.</p>
* <p>
* The value of this field is <code>"upnp:artistDiscographyURI"</code>.
* </p>
* Values must be properly escaped URIs as described in
* [<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>].
* <br>getMetadata() will return a String.
* @see MetadataNode#getMetadata(String)
*/
public static final String ARTIST_DISCOGRAPHY = "upnp:albumArtURI";
public static final String ARTIST_DISCOGRAPHY = "upnp:artistDiscographyURI";
/**
* Reference to lyrics of a track or album.
......@@ -273,10 +274,6 @@ public interface UPnPConstants
* </p>
* Values must be properly escaped URIs as described in
* [<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>].
* <br>
* <p class="TODO">
* IB: Do we want a key/value pair icon -> java.awt.Image ?
* </p>
* @see MetadataNode#getMetadata(String)
*/
public static final String ICON_REF = "upnp:icon";
......
......@@ -13,12 +13,26 @@ import org.ocap.hn.content.ContentEntry;
public interface NetRecordingEntry extends ContentEntry {
/**
* Key for returning the property which indicates that this entry is a
* NetRecordingEntry. Values returned for this key will be represented
* as a Boolean.
* Key constant for retrieving the CDS reference of this recording entry
* from this entry's metadata. Values returned for this key will be represented
* as a String.
*/
public static final String PROP_NET_RECORDING_ENTRY = "ocap:isNetRecordingEntry";
public static final String PROP_CDS_REFERENCE = "ocap:cdsReference";
/**
* Key constant for retrieving the RCI list of this recording entry
* from this entry's metadata. Values returned for this key will be represented
* as a String.
*/
public static final String PROP_RCI_LIST = "ocap:RCIList";
/**
* Key constant for retrieving the scheduled CDS entry ID of this recording entry
* from this entry's metadata. Values returned for this key will be represented
* as a String.
*/
public static final String PROP_SCHEDULED_CDS_ENTRY_ID = "ocap:scheduledCDSEntryID";
/**
* Retrieves the local individual RecordingContentItems that make up this
* series recording.
......
......@@ -43,14 +43,21 @@ public interface RecordingContentItem extends ContentItem
/**
* Key constant for retrieving the source ID of this recording item
* from this item's metadata. Values returned for this key will be represented
* as an Integer.
* as a String.
*/
public static final String PROP_SOURCE_ID = "ocap:scheduledChannelID";
/**
* Key constant for retrieving the source ID type of this recording item
* from this item's metadata. Values returned for this key will be represented
* as a String.
*/
public static final String PROP_SOURCE_ID_TYPE = "ocap:scheduledChannelIDType";
/**
* Key constant for retrieving the destination of this recording item
* from this item's metadata. Values returned for this key will be represented
* as an org.ocap.hn.content.ContentContainer.
* as a String.
*/
public static final String PROP_DESTINATION = "ocap:destination";
......@@ -92,17 +99,24 @@ public interface RecordingContentItem extends ContentItem
/**
* Key constant for retrieving the estimated space required for this recording item
* from this item's metadata. Values returned for this key will be represented
* as an Integer.
* as a Long.
*/
public static final String PROP_SPACE_REQUIRED = "ocap:spaceRequired";
/**
* Key constant for retrieving the location of content associated with this
* recording item from this item's metadata. Values returned for this key
* will be represented as an array of Strings.
* will be represented as a String.
*/
public static final String PROP_CONTENT_URI = "ocap:contentURI";
/**
* Key constant for retrieving the media first time for this recording item
* from this item's metadata. Values returned for this key will be represented
* as a Long.
*/
public static final String PROP_MEDIA_FIRST_TIME = "ocap:mediaFirstTime";
/**
* Key constant for retrieving the presentation point for this recording item
* from this item's metadata. Values returned for this key will be represented
......@@ -124,25 +138,6 @@ public interface RecordingContentItem extends ContentItem
*/
public static final String PROP_MSO_CONTENT = "ocap:msoContentIndicator";
/**
* Key constant for retrieving the reason this recording had been deleted.
* Values returned for this key will be represented as an Integer.
*/
public static final String PROP_DELETION_REASON = "ocap:deletionReason";
/**
* Key constant for retrieving the time at which content associated with this
* recording was deleted. Values returned for this key will be represented
* as a java.util.Date.
*/
public static final String PROP_DELETION_TIME = "ocap:deletionTime";
/**
* Key constant for retrieving the reason this recording has failed.
* Values returned for this key will be represented as an Integer.
*/
public static final String PROP_FAILURE_REASON = "ocap:failureReason";
/**
* Key constant for retrieving the ID of any NetRecordingEntry
* containing this RecordingContentItem.
......@@ -196,4 +191,3 @@ public interface RecordingContentItem extends ContentItem
*/
String getRecordingEntryID();
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment