bbc.rd.tvanytime.search
Interface LocationResolution

All Known Implementing Classes:

ContentReferencingTable, ProgramLocationTable

public interface LocationResolution

LocationResolution: Interface for location resolution services.

Version:

1.0

Author:

Tristan Ferne, BBC Research & Development, April 2002

Method Summary

java.util.Vector	getSchedule(java.util.Date startTime, java.util.Date endTime) Returns array of CRIDs for all events that start at a time between the start time and the end time.
java.util.Vector	getSchedule(java.util.Date startTime, java.util.Date endTime, java.lang.String serviceID) Returns array of CRIDs for all events that start at a time between the start time and the end time and are on the specified service.
java.util.Vector	resolveLeafCRID(ContentReference crid) Returns Vector of all locations for this CRID.
java.util.Vector	resolveLeafCRID(ContentReference crid, java.lang.String serviceID) Returns Vector of all locations for this CRID on the specified service.

Method Detail

resolveLeafCRID

java.util.Vector resolveLeafCRID(ContentReference crid)
                                 throws SearchInterfaceNotSupportedException

Returns Vector of all locations for this CRID. This is implemented within the ProgramLocationTable, where CRIDs are known to point to locators. The 'resolveCRID' method is implemented within the ContentReferencingTable, where CRIDs can point either to locators or other CRIDS.

Parameters:

crid - CRID to search for.

Returns:

Vector of all locations or a Vector of member ContentReferences for this CRID.

Throws:

SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

resolveLeafCRID

java.util.Vector resolveLeafCRID(ContentReference crid,
                                 java.lang.String serviceID)
                                 throws SearchInterfaceNotSupportedException

Returns Vector of all locations for this CRID on the specified service. This is implemented within the ProgramLocationTable, where CRIDs are known to point to locators. The 'resolveCRID' method is implemented within the ContentReferencingTable, where CRIDs can point either to locators or other CRIDS.

Parameters:

crid - CRID to search for.

serviceID - The serviceID of the service we are interested in.

Returns:

Vector of all locations or a Vector of member ContentReferences for this CRID.

Throws:

SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getSchedule

java.util.Vector getSchedule(java.util.Date startTime,
                             java.util.Date endTime)
                             throws SearchInterfaceNotSupportedException

Returns array of CRIDs for all events that start at a time between the start time and the end time. It is recommended that implementations return this array in time order.

Parameters:

startTime - Start time of schedule.

endTime - End time of schedule.

Returns:

Vector of all ContentReferences in this time period.

Throws:

SearchInterfaceNotSupportedException - If the implementation doesn't support this function.

getSchedule

java.util.Vector getSchedule(java.util.Date startTime,
                             java.util.Date endTime,
                             java.lang.String serviceID)
                             throws SearchInterfaceNotSupportedException

Returns array of CRIDs for all events that start at a time between the start time and the end time and are on the specified service. It is recommended that implementations return this array in time order.

Parameters:

startTime - Start time of schedule.

endTime - End time of schedule.

serviceID - The serviceID of the service we are interested in.

Returns:

Vector of all ContentReferences on this service in this time period.

Throws:

SearchInterfaceNotSupportedException - If the implementation doesn't support this function.