ORG.oclc.fmts
Class FieldData

java.lang.Object
  |
  +--ORG.oclc.fmts.FieldData

public class FieldData

extends Object

The FieldData class defines the record field specification for a field in a RuleSpec formatting specification.

See Also:

RuleSpec, RulesBasedDisplayGenerator

Field Summary

boolean	fieldAnchorDefined boolean data type defining whether object definition has field anchor indexes defined.
String	fieldAnchorIndex String data type defining the name of the index for the whole field, so that all subfields in the description should be grouped together as one anchor for each occurrence of the field.
boolean	fieldDataOrder boolean data type defining the order to retrieve the field data where the default is true indicating to use dataordered retrieval.
String	fieldLabel String data type containing the field label where the default is an empty string('').
String	fields String data type containing the list of record field tags.
String	fieldSep String data type containing the field separator where the default is a space(' ').
String	fieldTrailer String data type containing the field trailer where the default is an empty string('').
String	indicator1ForField String data type containing the list of acceptable indicator1 values for the field - this is a comma separated list of indicators or "*" for all.
String	indicator2ForField String data type containing the list of acceptable indicator2 values for the field - this is a comma separated list of indicators or "*" for all.
String[]	sfAnchorIndex String array object containing query anchor indexid for each of the entries specified in the anchors[] object.
String[]	sfAnchorSep String array object containing the subfield separators that are used in the anchor for a search term (versus the screen display of the term) where the default is a space(' ').
boolean[]	sfCombine boolean array object defining whether the subfields should be combined for a field where the default is false.
boolean[]	sfDataOrder boolean array object defining the order to retrieve the subfield data where the default is true indicating to use dataordered retrieval.
String[]	sfLabel String array object containing the subfield labels where the default is an empty string('').
boolean	sfldAnchorsDefined boolean data type defining whether object definition has subfield anchor indexes defined.
int	sfRepeatFld integer data type defining the repeat subfield tag where the default indicates not to break on repeating fields.
String[]	sfSep String array object containing the subfield separators where the default is a space(' ').
String[]	sfTrailer String array object containing the subfield trailer where the default is an empty string('').
String[]	subfields String array object type containing the list of record subfield tags.

Method Summary

String	fieldLabel(String lineBreak) Retrieves a String containing the field label where the input specified BREAK string is replaced with the line break string in the input.
String	fieldSep(String lineBreak) Retrieves a String containing the field separator where the input specified BREAK string is replaced with the line break string in the input.
String	fieldTrailer(String lineBreak) Retrieves a String containing the field trailer where the input specified BREAK string is replaced with the line break string in the input.
String[]	sfLabel(String lineBreak) Retrieves a String containing the subfield label where the input specified BREAK string is replaced with the line break string in the input.
String[]	sfSep(String lineBreak) Retrieves a String containing the subfield separator where the input specified BREAK string is replaced with the line break string in the input.
String[]	sfTrailer(String lineBreak) Retrieves a String containing the subfield trailer where the input specified BREAK string is replaced with the line break string in the input.
String	toString() Generates a String representation of the object.
static String[]	translateBREAK(String[] inString, String lineBreak) Translates the strings in the incomings String array to the correct line break character, where the input specified BREAK string is replaced with the line break string in the input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fields

public String fields

String data type containing the list of record field tags.

indicator1ForField

public String indicator1ForField

String data type containing the list of acceptable indicator1 values for the field - this is a comma separated list of indicators or "*" for all.

indicator2ForField

public String indicator2ForField

String data type containing the list of acceptable indicator2 values for the field - this is a comma separated list of indicators or "*" for all.

fieldSep

public String fieldSep

String data type containing the field separator where the default is a space(' ').

fieldLabel

public String fieldLabel

String data type containing the field label where the default is an empty string('').

fieldTrailer

public String fieldTrailer

String data type containing the field trailer where the default is an empty string('').

fieldDataOrder

public boolean fieldDataOrder

boolean data type defining the order to retrieve the field data where the default is true indicating to use dataordered retrieval.

fieldAnchorIndex

public String fieldAnchorIndex

String data type defining the name of the index for the whole field, so that all subfields in the description should be grouped together as one anchor for each occurrence of the field.

subfields

public String[] subfields

String array object type containing the list of record subfield tags.

sfSep

public String[] sfSep

String array object containing the subfield separators where the default is a space(' ').

sfLabel

public String[] sfLabel

String array object containing the subfield labels where the default is an empty string('').

sfTrailer

public String[] sfTrailer

String array object containing the subfield trailer where the default is an empty string('').

sfAnchorIndex

public String[] sfAnchorIndex

String array object containing query anchor indexid for each of the entries specified in the anchors[] object.

sfCombine

public boolean[] sfCombine

boolean array object defining whether the subfields should be combined for a field where the default is false.

sfDataOrder

public boolean[] sfDataOrder

boolean array object defining the order to retrieve the subfield data where the default is true indicating to use dataordered retrieval.

sfAnchorSep

public String[] sfAnchorSep

String array object containing the subfield separators that are used in the anchor for a search term (versus the screen display of the term) where the default is a space(' ').

sfRepeatFld

public int sfRepeatFld

integer data type defining the repeat subfield tag where the default indicates not to break on repeating fields.

sfldAnchorsDefined

public boolean sfldAnchorsDefined

boolean data type defining whether object definition has subfield anchor indexes defined.

fieldAnchorDefined

public boolean fieldAnchorDefined

boolean data type defining whether object definition has field anchor indexes defined.

Method Detail

fieldSep

public final String fieldSep(String lineBreak)

Retrieves a String containing the field separator where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

fieldLabel

public final String fieldLabel(String lineBreak)

Retrieves a String containing the field label where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

fieldTrailer

public final String fieldTrailer(String lineBreak)

Retrieves a String containing the field trailer where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

sfSep

public final String[] sfSep(String lineBreak)

Retrieves a String containing the subfield separator where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

translateBREAK

public static final String[] translateBREAK(String[] inString,
                                            String lineBreak)

Translates the strings in the incomings String array to the correct line break character, where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

inString - the incoming strings

lineBreak - the real line break character for the format

sfLabel

public final String[] sfLabel(String lineBreak)

Retrieves a String containing the subfield label where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

sfTrailer

public final String[] sfTrailer(String lineBreak)

Retrieves a String containing the subfield trailer where the input specified BREAK string is replaced with the line break string in the input.

Parameters:

lineBreak - the real line break character for the format

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class Object