Open SiteSearch 4.1.1
Final

ORG.oclc.fmts
Class ZBaseFormatter

java.lang.Object
  |
  +--ORG.oclc.fmts.ZBaseFormatter
Direct Known Subclasses:
ERICbriefMarcFmt, ERICfullMarcFmt, ExampleOPACFmt, ThesaurusBriefBerFmt, WCATbriefBerFmt, WCATbriefMarcFmt, WCATbriefTextFmt, WCATfullMarcFmt

public class ZBaseFormatter
extends Object
implements Z39Formatter

The ZBaseFormatter class is the parent class for all the ZBase database record formatting classes that convert BER data to MARC format. It defines variables commonly used by all the formats and houses commonly used methods to format database records.

See Also:
Z39Formatter, MarcBuilder, FormatBerUtil

Field Summary
protected  String fieldData
          String data type containing data for a record field.
protected  FormatBerUtil fmtUtil
          FormatBerUtil object containing methods to retrieve data fields from a BER record.
protected  byte[] marcbytes
          byte array object used to store byte data from a data field.
protected  MarcBuilder marcRec
          MarcBuilder object containing methods to build a MARC record.
protected  DataDir newDir
          DataDir object containing the returned record from the formatting activity.
 
Constructor Summary
ZBaseFormatter()
          Constructs a ZBaseFormatter object.
 
Method Summary
 BerString buildTextRecord(String textData)
          Creates a BerString object containing a single node containing the input text record.
 BerString[] doFormat(BerString[] records)
          Parent doFormat method for an input array of BerString objects that returns a null when called at this level.
 BerString doFormat(DataDir record)
          Parent doFormat method for an input DataDir object that returns a null when called at this level.
 BerString makeMarcBerString(String marcString)
          Creates a BerString object containing a Marc representation of the input marc record string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fieldData

protected String fieldData
String data type containing data for a record field.

marcRec

protected MarcBuilder marcRec
MarcBuilder object containing methods to build a MARC record.

marcbytes

protected byte[] marcbytes
byte array object used to store byte data from a data field.

fmtUtil

protected FormatBerUtil fmtUtil
FormatBerUtil object containing methods to retrieve data fields from a BER record.

newDir

protected DataDir newDir
DataDir object containing the returned record from the formatting activity.
Constructor Detail

ZBaseFormatter

public ZBaseFormatter()
Constructs a ZBaseFormatter object.
Method Detail

doFormat

public BerString doFormat(DataDir record)
Parent doFormat method for an input DataDir object that returns a null when called at this level.
Specified by:
doFormat in interface Z39Formatter
Parameters:
record - a BER record.
Returns:
a null.

doFormat

public BerString[] doFormat(BerString[] records)
Parent doFormat method for an input array of BerString objects that returns a null when called at this level.
Specified by:
doFormat in interface Z39Formatter
Parameters:
records[] - an array of BER formatted records.
Returns:
a null.

makeMarcBerString

public BerString makeMarcBerString(String marcString)
Creates a BerString object containing a Marc representation of the input marc record string.
Parameters:
marcString - the Marc record string.
Returns:
the Marc record in a BER format.

buildTextRecord

public BerString buildTextRecord(String textData)
Creates a BerString object containing a single node containing the input text record.
Parameters:
textData - the text record string.
Returns:
the text record in a BER format.

Open SiteSearch 4.1.1
Final