org.mycore.services.z3950
Interface MCRZ3950Query

All Known Implementing Classes:

MCRZ3950QueryService

public interface MCRZ3950Query

Dieses Java-Interface beschreibt die Syntax der grundlegenen Funktionen für den Z39.50-Suchservice.

Version:

1.0

Author:

Andreas de Azevedo

Method Summary

void	cutDownTo(int maxresults) Schneidet das Ergebnisdokument an einer bestimmten Stelle ab.
byte[]	getDocumentAsByteArray() Gibt alle Ergebnisse als Bytestrom zurück.
int	getIndex()
String	getQuery()
int	getSize() Gibt die Anzahl der Ergebnisse zurück.
boolean	search() Führt eine Suchanfrage in MyCoRe aus.
void	setIndex(int index) Verkürzt das Ergebnisdokument auf das Dokument mit einem bestimmten Index.
void	setQuery(String query) Setzt eine Z39.50-Suchanfrage
void	sort()

Method Detail

cutDownTo

void cutDownTo(int maxresults)

Schneidet das Ergebnisdokument an einer bestimmten Stelle ab.

Parameters:

maxresults - Die Anzahl noch zu verbleibender Ergebnisse.

sort

void sort()

getDocumentAsByteArray

byte[] getDocumentAsByteArray()

Gibt alle Ergebnisse als Bytestrom zurück.

Returns:

Das Ergebnisdokument als Byte-Array, null falls es keine Ergebnisse gab.

search

boolean search()

Führt eine Suchanfrage in MyCoRe aus.

Returns:

True falls es Ergebnisse gab, sonst False.

getSize

int getSize()

Gibt die Anzahl der Ergebnisse zurück.

Returns:

Die Anzahl der Dokumente in der Ergebnisliste.

getIndex

int getIndex()

setIndex

void setIndex(int index)

Verkürzt das Ergebnisdokument auf das Dokument mit einem bestimmten Index.

Parameters:

index - Der Index des gewünschten Ergebnisses.

getQuery

String getQuery()

setQuery

void setQuery(String query)

Setzt eine Z39.50-Suchanfrage

Parameters:

query - Eine Suchanfrage im Z39.50-Format (Prefix)