org.dvb.tvanytime.metadata
Class FieldIDDefinitionList

java.lang.Object
  extended by org.dvb.tvanytime.metadata.FieldIDDefinitionList

public abstract class FieldIDDefinitionList
extends java.lang.Object

Class listing a set of fieldID strings and allowing the corresponding XPath expressions to be obtained.


Method Summary
abstract  boolean containsKey(java.lang.String fieldID)
          Test whether the specified fieldID is included in this FieldIDDefinitionList.
abstract  java.util.Enumeration getFieldIDs()
          Get the fieldIDs supported by this FieldIDDefinitionList.
static FieldIDDefinitionList getInstance()
          Get an instance of the default FieldIDDefinitionList.
static FieldIDDefinitionList getInstance(java.lang.String path)
          Get an instance of the FieldIDDefinitionList for a given server.
abstract  java.lang.String getXPath(java.lang.String fieldID)
          Get the XPath corresponding to a fieldID.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static FieldIDDefinitionList getInstance()
Get an instance of the default FieldIDDefinitionList.

Returns:
the default FieldIDDefinitionList

getInstance

public static FieldIDDefinitionList getInstance(java.lang.String path)
                                         throws java.net.MalformedURLException,
                                                java.io.IOException
Get an instance of the FieldIDDefinitionList for a given server.

Parameters:
path - the HTTP URL of the server
Returns:
the FieldIDDefinitionList of the specified server
Throws:
java.net.MalformedURLException - if the URL is invalid
java.io.IOException - if an IOException occurs

getXPath

public abstract java.lang.String getXPath(java.lang.String fieldID)
                                   throws DatabaseException
Get the XPath corresponding to a fieldID.

Parameters:
fieldID - a String that contains a fieldID
Returns:
a String that contains the corresponding XPath
Throws:
DatabaseException - if the fieldID is not found in this FieldIDDefinitionList

containsKey

public abstract boolean containsKey(java.lang.String fieldID)
Test whether the specified fieldID is included in this FieldIDDefinitionList.

Parameters:
fieldID - a String that contains a fieldID
Returns:
true if this fieldID is included in this FieldIDDefinitionList, false otherwise

getFieldIDs

public abstract java.util.Enumeration getFieldIDs()
Get the fieldIDs supported by this FieldIDDefinitionList.

Returns:
an enumeration of the fieldID strings.