Class resource.CSTRSourceDescription 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class resource.CSTRSourceDescription 

java.lang.Object
   |
   +----resource.SourceDescription
           |
           +----wais.WAISSourceDescription
                   |
                   +----resource.CSTRSourceDescription
public final class CSTRSourceDescription
extends WAISSourceDescription
Description of the characteristics specific to the CSTR source. The bulk of this class is a set of static varliable definitions that are used to set the values in the SourceDescription super class. These settings are used in various parts of the implementatin to do things like query translations. The implementation is organized so that the service provider should create a new SourceDescription class for each source provided by the resource. Note that this is a type of WAISSourceDescription and many of the settings are done in that superclass.

Variable Index

o accessConstraints
A String value giving a free text description of the contraints or legal prerequisites for accessing the source.
o administrator
A String value indicating the administrator of the source
o contentSummaryLinkage
A String value giving the URL of the source content summary.
o fieldsSupported
A 2-D string array indicating the fields supported.
o fieldsTable
Hashtable holding all supported fields.
o fieldsTranslation
translation tables to go from STARTS fields to WAIS fields.
o linkage
A String value giving the URL where the source should be queried
o otherMetaAttributes
settings for meta attributes in other attribute sets.
o sampleDataBaseResultsURL
A string indicating the URL from which to get the query results for a sample document collection.
o sourceAbstract
A String value giving a free text abstract of this source.
o sourceLanguage
A String array where each element indicates, in RFC1877 format, a language present at the source.
o sourceName
A String giving the name of the source.

Constructor Index

o CSTRSourceDescription()
Constructor which loads the generic super class with the source specific information.

Method Index

o GetDateExpires()
Return an ISO-1807 representation of when metadata for this source expires.
o GetDateModified()
Return an ISO-1807 representation of when the source was modified
o TranslateField(String, String)
Return a String that is a translation from STARTS field to WAIS field.

Variables

o linkage 
  public static String linkage
A String value giving the URL where the source should be queried
o contentSummaryLinkage 
  public static String contentSummaryLinkage
A String value giving the URL of the source content summary.
o sampleDataBaseResultsURL 
  public static String sampleDataBaseResultsURL
A string indicating the URL from which to get the query results for a sample document collection.
o fieldsSupported 
  public static String fieldsSupported[][]
A 2-D string array indicating the fields supported. Each row is data for a field. The elements (columns) of a row are as follows: 0 - two tokens . Note that rows for all basic-1 fields should exist. Rows for fields in other attribute sets may be added 1 - a string value (true of false) indicating whether the field is supported at the source 2 - a set of tokens indicating special languages supported for this field (e.g. "en-US es-MX") Note that this information is source (not engine) specific
o fieldsTranslation 
  protected static String fieldsTranslation[][]
translation tables to go from STARTS fields to WAIS fields. Formatted as a two-D array with column 0 being the STARTS field and column 1 the WAIS equivalent. Note that this information is source, not engine, specific.
o sourceLanguage 
  public static String sourceLanguage[]
A String array where each element indicates, in RFC1877 format, a language present at the source.
o sourceName 
  public static String sourceName
A String giving the name of the source.
o sourceAbstract 
  public static String sourceAbstract
A String value giving a free text abstract of this source.
o accessConstraints 
  public static String accessConstraints
A String value giving a free text description of the contraints or legal prerequisites for accessing the source.
o administrator 
  public static String administrator
A String value indicating the administrator of the source
o otherMetaAttributes 
  public static String otherMetaAttributes[][][]
settings for meta attributes in other attribute sets. This should be a three dimensional array where each element in a row is as follows: 0 - name of the attribute set 1 - name of the attribute 2 - value of the attribute set For example, a row might be initialized to: {"foo-1", "emporer", "Caeser"}
o fieldsTable 
  public static Hashtable fieldsTable
Hashtable holding all supported fields. key is value is set of language tokens or empty string if no special languages.

Constructors

o CSTRSourceDescription 
  public CSTRSourceDescription()
Constructor which loads the generic super class with the source specific information.

Methods

o TranslateField 
  public String TranslateField(String attrSet,
                               String field)
Return a String that is a translation from STARTS field to WAIS field.
Parameters:
attrSet - Attribute set of the WAIS field to be translated.
field - Field name of the WAIS field to be translated.
Returns:
the String translation of the input attribute set/field pair.
Overrides:
TranslateField in class SourceDescription
o GetDateModified 
  public String GetDateModified()
Return an ISO-1807 representation of when the source was modified
Returns:
ISO 1807 date of when the source was modified.
Overrides:
GetDateModified in class SourceDescription
o GetDateExpires 
  public String GetDateExpires()
Return an ISO-1807 representation of when metadata for this source expires.
Returns:
ISO-1807 date of when this metadata expires.
Overrides:
GetDateExpires in class SourceDescription 
All Packages  Class Hierarchy  This Package  Previous  Next  Index