de.unidu.is.retrieval.hyrex
Class HyREXRetrieverUIMetadata

java.lang.Object
  extended byde.unidu.is.retrieval.AbstractRetrieverUIMetadata
      extended byde.unidu.is.retrieval.hyrex.HyREXRetrieverUIMetadata
All Implemented Interfaces:
RetrieverUIMetadata

public class HyREXRetrieverUIMetadata
extends AbstractRetrieverUIMetadata

A class describing metadata for a MIND 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

Field Summary
 
Fields inherited from class de.unidu.is.retrieval.AbstractRetrieverUIMetadata
collections, retriever, schema, sortedAttributes, sortedSearchAttributes, sortModel
 
Constructor Summary
HyREXRetrieverUIMetadata(Retriever retriever)
          Creates a new instance.
 
Method Summary
 java.lang.String[] getAuthorAttributeNames()
          Returns all attribute names related to a potential author field.
 java.lang.String[] getCollections()
          Returns all collections supported by the retriever.
 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.
 
Methods inherited from class de.unidu.is.retrieval.AbstractRetrieverUIMetadata
extract, extractList, getCollectionFromDocID, getRetriever, getSchema, getSortedAttributeNames, getSortedSearchAttributeNames, toHuman
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HyREXRetrieverUIMetadata

public HyREXRetrieverUIMetadata(Retriever retriever)
Creates a new instance.

Parameters:
retriever - associated retriever
Method Detail

getCollections

public java.lang.String[] getCollections()
Returns all collections supported by the retriever.

The collections are queried from the MIND dispatcher.

Returns:
attray of collection names, can be empty

getSortModel

public java.lang.String[] getSortModel()
Returns the attributes names with could be used for sorting.

This implementation only uses "title", "author", "year", "yearperiod".

Specified by:
getSortModel in interface RetrieverUIMetadata
Overrides:
getSortModel in class AbstractRetrieverUIMetadata
Returns:
attributes names with could be used for sorting
See Also:
RetrieverUIMetadata.getSortModel()

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