|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DatabaseQueryResult
Class that holds the result of a database query. When a database query is completed the
DatabaseQueryResult will contain all the metadata that matches the query.
The document will be in the form of a TV Anytime compliant document
(i.e. the top level element will be a TVAMain, followed by all the programme/group/... tables)
The getAvailableTables()
method can be used to see what
tables (ProgramInformation, GroupInformation, etc) are in the result.
Database
,
DatabaseQuery
,
ResultListener
Method Summary | |
---|---|
void |
close()
Closes the result and releases all system resources, removes all listeners. |
Table[] |
getAvailableTables()
Returns a list of the metadata tables present in this result set. |
java.lang.Exception |
getFailedException()
Get the exception that caused getStatus() to return REQUEST_FAILED or
RESPONSE_INCOMPLETE . |
ListIterator |
getFragments()
Get a ListIterator for all of the TV Anytime fragments in this result. |
ListIterator |
getFragments(java.lang.String[] fragmentNames)
Get a ListIterator for the specified TV Anytime fragment types that are found in this result. |
Element |
getRootElement()
Get the root element of this result. |
int |
getStatus()
Returns the status of this DatabaseQueryResult at completion. |
ListIterator |
getUnknownFragments()
Get a ListIterator of the unknown fragments that are found in this result. |
ListIterator |
getUnknownFragments(int DVBContextPath)
Get a ListIterator of unknown fragments with the specified DVBContextPath
that are found in this result. |
boolean |
isComplete()
Indicates that the database query has been completed. |
Method Detail |
---|
Table[] getAvailableTables()
isComplete()
method
returns true.
Table
, with one element for each table in the result. If there are no tables
in the result, an empty array is returned. For each element of the array the methods Table.getSortCriteriaFieldIDs()
and Table.getSortCriteriaOrderings()
can be used to determine whether the results from a particular table
have been sorted.Element getRootElement()
isComplete()
method
returns true.
ListIterator getFragments()
isComplete()
method returns true. Each fragment is an object that implements the Element interface. For example a
fragment for the description of one TV programme would be an element with the name "ProgramInformation".
Note that these fragments do not contain TVAMain etc and therefore calling getParent
on
a fragment will return null.
ListIterator getFragments(java.lang.String[] fragmentNames)
isComplete()
method returns true. Each fragment is an object that implements the Element interface. For example a
fragment for the description of one TV programme would be an element with the name "ProgramInformation".
Note that these fragments do not contain TVAMain etc and therefore calling getParent
on
a fragment will return null.
fragmentNames
- the list of required fragments. Each item is a String
that contains the name of the top level Element of the fragment, for
example "ProgramInformation" to request ProgramInformation fragments.
boolean isComplete()
ResultListener
. The completion of the database query will be signalled by the notifyFinished
method of ResultListener
after which the isComplete method will return true.
int getStatus()
isComplete()
method returns true is unspecified.
ResultListener.REQUEST_COMPLETED
, ResultListener.REQUEST_FAILED
,
ResultListener.RESPONSE_INCOMPLETE
and ResultListener.RESPONSE_TRUNCATED
void close()
java.lang.Exception getFailedException() throws java.lang.IllegalStateException
getStatus()
to return REQUEST_FAILED
or
RESPONSE_INCOMPLETE
.
DatabaseException
.
java.lang.IllegalStateException
- if getStatus()
does not return ResultListener.REQUEST_FAILED
or
ResultListener.RESPONSE_INCOMPLETE
ListIterator getUnknownFragments()
DVBContextPath
value that is not
recognised by the resident decoder. If there are no unknown fragments this method will return null.
Each of the returned fragments is represented by an UnknownElementContent
object. The UnknownElementContent.readBits(int)
method of these objects will
access the FragmentUpdatePayload
of each fragment.
UnknownElementContent
objects or null.ListIterator getUnknownFragments(int DVBContextPath)
DVBContextPath
that are found in this result.
An unknown fragment is one with a DVBContextPath
value that is not
recognised by the resident decoder. If the specified DVBContextPath
value
is one supported by the resident decoder this method will return null. If
the value is not supported but there are no matching fragments an empty
ListIterator will be returned.
Each of the returned fragments is represented by an UnknownElementContent
object. The UnknownElementContent.readBits(int)
method of these objects will
access the FragmentUpdatePayload
of each fragment.
DVBContextPath
- the DVBContextPath
of the required fragments.
UnknownElementContent
objects.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |