Open SiteSearch 4.1.1
Final

ORG.oclc.db
Class ElementSetNameF

java.lang.Object
  |
  +--ORG.oclc.db.ElementSetNameF
Direct Known Subclasses:
ElementSetNameB, ElementSetNameB2, ElementSetNameBH, ElementSetNameBI, ElementSetNameFA, ElementSetNameFH, ElementSetNameFI, ElementSetNameITEM, ElementSetNameR, ElementSetNameSCORES, ElementSetNameT, ElementSetNameX

public class ElementSetNameF
extends Object
implements ElementSetName

ElementSetNameF class is used to retrieve records from a Newton Database class for the input ElementSet Name 'F'. It also contains many methods that other implementations of the ElementSetName interface can use by extending this class.

See Also:
ElementSetName, DbNewton

Field Summary
protected  Class briefBerFormat
          Class object containing the brief ber formatting class used to create 'small' ber records for ElementSetNames starting with 'B' requesting the BER record syntax.
protected  Class briefMarcFormat
          Class object containing the brief marc formatting class to create 'small' marc records for ElementSetNames starting with 'B' requesting a MARC record syntax.
protected  Class briefOpacFormat
          Class object containing the formatting class to create brief OPAC record syntax records.
protected  Class briefTextFormat
          Class object containing the brief Text formatting class to create 'small' text records for ElementSetNames starting with 'B' requesting the SUTRS record syntax.
protected  String dbname
          String data type containing the database name.
protected  Class fullASCIIFormat
          Class object containing the full Text formatting class to create full text records for ElementSetNames starting with 'T' requesting a SUTRS record syntax.
protected  Class fullMarcFormat
          Class object containing the full marc formatting class to create full MARC records for ElementSetNames starting with 'F' requesting a MARC record syntax.
protected  Class fullOpacFormat
          Class object containing the formatting class to create full OPAC record syntax records.
protected  Class fullTextFormat
          Class object containing the full Text formatting class to create text records for ElementSetNames starting with 'F' requesting the SUTRS record syntax.
 
Constructor Summary
ElementSetNameF()
           
 
Method Summary
protected  DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb, Class fmtClass, String parms, String format, int[] recnos, long[] scores, Object dbUserData)
          Retrieves records from the database for the input elementSetname.
 DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb, String syntax, String parms, int[] recnos, long[] scores, Object dbUserData)
          Invokes the getRecords method to retrieve the records from the database using elementSetName 'F' for the requested syntax
 DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb, String syntax, String parms, int[] recnos, Object dbUserData)
          Invokes the getRecords method to retrieve the records from the database in the requested syntax where there are no rank scores to retrieve.
 void initialize(String dbName, IniFile inifile)
          Initializes the ElementSetNameF object for the input database, database name, and inifile.
 String toString()
          Generates a String representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

briefBerFormat

protected Class briefBerFormat
Class object containing the brief ber formatting class used to create 'small' ber records for ElementSetNames starting with 'B' requesting the BER record syntax.

briefTextFormat

protected Class briefTextFormat
Class object containing the brief Text formatting class to create 'small' text records for ElementSetNames starting with 'B' requesting the SUTRS record syntax.

briefMarcFormat

protected Class briefMarcFormat
Class object containing the brief marc formatting class to create 'small' marc records for ElementSetNames starting with 'B' requesting a MARC record syntax.

fullTextFormat

protected Class fullTextFormat
Class object containing the full Text formatting class to create text records for ElementSetNames starting with 'F' requesting the SUTRS record syntax.

fullMarcFormat

protected Class fullMarcFormat
Class object containing the full marc formatting class to create full MARC records for ElementSetNames starting with 'F' requesting a MARC record syntax.

fullASCIIFormat

protected Class fullASCIIFormat
Class object containing the full Text formatting class to create full text records for ElementSetNames starting with 'T' requesting a SUTRS record syntax.

fullOpacFormat

protected Class fullOpacFormat
Class object containing the formatting class to create full OPAC record syntax records.

briefOpacFormat

protected Class briefOpacFormat
Class object containing the formatting class to create brief OPAC record syntax records.

dbname

protected String dbname
String data type containing the database name.
Constructor Detail

ElementSetNameF

public ElementSetNameF()
Method Detail

initialize

public void initialize(String dbName,
                       IniFile inifile)
Initializes the ElementSetNameF object for the input database, database name, and inifile.
Specified by:
initialize in interface ElementSetName
Parameters:
dbName - the database name
inifile - the IniFile object containing the configuration information for the database.

toString

public String toString()
Generates a String representation of the object.
Overrides:
toString in class Object

getRecords

public DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb,
                                  String syntax,
                                  String parms,
                                  int[] recnos,
                                  long[] scores,
                                  Object dbUserData)
                           throws Diagnostic1
Invokes the getRecords method to retrieve the records from the database using elementSetName 'F' for the requested syntax
Specified by:
getRecords in interface ElementSetName

getRecords

public DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb,
                                  String syntax,
                                  String parms,
                                  int[] recnos,
                                  Object dbUserData)
                           throws Diagnostic1
Invokes the getRecords method to retrieve the records from the database in the requested syntax where there are no rank scores to retrieve.
Specified by:
getRecords in interface ElementSetName

getRecords

protected DbPresentData[] getRecords(ORG.oclc.Newton.db.NewtonDatabase thisDb,
                                     Class fmtClass,
                                     String parms,
                                     String format,
                                     int[] recnos,
                                     long[] scores,
                                     Object dbUserData)
                              throws Diagnostic1
Retrieves records from the database for the input elementSetname. If rank scores are requested, then the appropriate calculations are made to retrieve that information.

Open SiteSearch 4.1.1
Final