de.unidu.is.retrieval
Interface RetrieverUIMetadata

All Known Implementing Classes:

AbstractRetrieverUIMetadata

public interface RetrieverUIMetadata

This interface describes metadata for a retriever which can be used by UIs for a reasonable handling of queries and documents.

Since:

2004-03-18

Version:

$Revision: 1.4 $, $Date: 2005/02/21 17:29:23 $

Author:

Henrik Nottelmann

Method Summary

java.lang.String	extract(org.w3c.dom.Document doc, java.lang.String attName) Extracts the content of the specified XML document given by the XPath expressions of the specified attribute.
java.util.List	extractList(org.w3c.dom.Document doc, java.lang.String attName) Extracts the content of the specified XML document given by the XPath expressions of the specified attribute.
java.lang.String[]	getAuthorAttributeNames() Returns all attribute names related to a potential author field.
java.lang.String	getCollectionFromDocID(java.lang.String docID) Returns the collection which is encoded in the specified doc ID.
java.lang.String[]	getCollections() Returns all collections supported by the retriever.
Retriever	getRetriever() Returns the associated retriever.
Schema	getSchema() Returns the schema used by the retriever.
java.lang.String[]	getSortedAttributeNames() Returns the attributes names with could be used for displaying details.
java.lang.String[]	getSortedSearchAttributeNames() Returns the attributes names with could be used for searching.
java.lang.String[]	getSortModel() Returns the attributes names with could be used for sorting.
java.lang.String[]	getTitleAttributeNames() Returns all attribute names related to a potential title field.
java.lang.String[]	getYearAttributeNames() Returns all attribute names related to a potential year field.
java.lang.String	toHuman(java.lang.String attName) Converts the specified attribute name into a human-readable label.

Method Detail

getRetriever

public Retriever getRetriever()

Returns the associated retriever.

Returns:

retriever

getSchema

public Schema getSchema()

Returns the schema used by the retriever.

Returns:

schema used by the retriever

getCollections

public java.lang.String[] getCollections()

Returns all collections supported by the retriever.

Returns:

attray of collection names, can be empty

getSortedSearchAttributeNames

public java.lang.String[] getSortedSearchAttributeNames()

Returns the attributes names with could be used for searching.

Returns:

attributes names with could be used for searching

getSortedAttributeNames

public java.lang.String[] getSortedAttributeNames()

Returns the attributes names with could be used for displaying details.

Returns:

attributes names with could be used for displaying details

getSortModel

public java.lang.String[] getSortModel()

Returns the attributes names with could be used for sorting.

Returns:

attributes names with could be used for sorting

toHuman

public java.lang.String toHuman(java.lang.String attName)

Converts the specified attribute name into a human-readable label.

Parameters:

attName - attribute name

Returns:

human-readable label

extract

public java.lang.String extract(org.w3c.dom.Document doc,
                                java.lang.String attName)

Extracts the content of the specified XML document given by the XPath expressions of the specified attribute. Multiple occurrences are concatenated (with "; " as separator).

Parameters:

doc - XML docoument

attName - attribute name

Returns:

extracted content

extractList

public java.util.List extractList(org.w3c.dom.Document doc,
                                  java.lang.String attName)

Extracts the content of the specified XML document given by the XPath expressions of the specified attribute. Each list entry equals one occurrence in the document.

Parameters:

doc - XML docoument

attName - attribute name

Returns:

extracted content

getTitleAttributeNames

public java.lang.String[] getTitleAttributeNames()

Returns all attribute names related to a potential title field.

This can be used by a GUI for displaying the document title.

Returns:

attribute names related to a potential title field

getAuthorAttributeNames

public java.lang.String[] getAuthorAttributeNames()

Returns all attribute names related to a potential author field.

This can be used by a GUI for displaying the document authors.

Returns:

attribute names related to a potential author field

getYearAttributeNames

public java.lang.String[] getYearAttributeNames()

Returns all attribute names related to a potential year field.

This can be used by a GUI for displaying years associated with a document.

Returns:

attribute names related to a potential year field

getCollectionFromDocID

public java.lang.String getCollectionFromDocID(java.lang.String docID)

Returns the collection which is encoded in the specified doc ID.

Parameters:

docID - document ID

Returns:

collection encoded in the doc ID, or null (no collection)