org.mycore.services.fieldquery
Interface MCRQueryClientInterface

All Known Implementing Classes:

MCRQueryClientBase, MCRQueryClientWebService

public interface MCRQueryClientInterface

Method Summary

Document	doRetrieveClassification(String level, String type, String classID, String categID, String format) Retrieves an classification part from remote host using the WebService.
Document	doRetrieveLinks(String from, String to, String type) Retrieves an link from remote host using the WebService.
Document	doRetrieveObject(String ID) Retrieves an Object from remote host using the defined service.
String	getAlias()
void	init(Element xmlhost)
void	search(Document inDoc, MCRResults results) Executes a query on a single remote host using the defined service.

Method Detail

init

void init(Element xmlhost)

getAlias

String getAlias()

search

void search(Document inDoc,
            MCRResults results)

Executes a query on a single remote host using the defined service.

Parameters:

inDoc - the query as W3C DOM document

results - the result list to add the hits to

doRetrieveObject

Document doRetrieveObject(String ID)

Retrieves an Object from remote host using the defined service.

Parameters:

hostAlias - the alias of the remote host as defined in hosts.xml

ID - the ID of the Object to retrieve

Returns:

the object document

doRetrieveClassification

Document doRetrieveClassification(String level,
                                  String type,
                                  String classID,
                                  String categID,
                                  String format)

Retrieves an classification part from remote host using the WebService.

Parameters:

level - the level of the classification to retrieve

type - the type of the classification to retrieve

classID - the class ID of the classification to retrieve

categID - the category ID of the classification to retrieve

format - of retrieved classification, valid values are: editor['['formatAlias']']|metadata

Returns:

the classification document

doRetrieveLinks

Document doRetrieveLinks(String from,
                         String to,
                         String type)

Retrieves an link from remote host using the WebService.

Parameters:

hostAlias - the alias of the remote host as defined in hosts.xml

from - the source of the link

to - the target of the link

type - the type of the link

Returns:

the mcr:result document