ORG.oclc.fmts.rules
Class AddRecordNumber

java.lang.Object
  |
  +--ORG.oclc.fmts.rules.RuleUtil
        |
        +--ORG.oclc.fmts.rules.AddRecordNumber

public class AddRecordNumber

extends RuleUtil

implements DisplayRule

The AddRecordNumber class is a record formatting rule that adds the input record Number value to the output formatting buffer. The HTML or Text specifications defined in the DisplayUserData object are used to delimit data found in the input record to create the formatted text.

The parameters recognized by this rule are:

beforeRecnoWrapperName

The name of the data wrapper entry that has the string to append before the record number, where the default, if not specified, is the wrapper element named beforeRecordNumber.

afterRecnoWrapperName

the name of the data wrapper entry that has the string to append after the record number, where the the default, if not specified, is the wrapper element named afterRecordNumber.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddRecordNumber()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Adds the current record number to the output format buffer for the input DataDir object,

Methods inherited from class ORG.oclc.fmts.rules.RuleUtil

appendEntityData, getData, getData, getWrapperData, getWrapperData, getWrapperDataFromRuleParm, labelMaker, saveDataInEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

AddRecordNumber

public AddRecordNumber()

Method Detail

doRule

public void doRule(DataDir dir,
                   int recordNumber,
                   RuleSpec ruleSpec,
                   FormatBerUtil fmtUtil,
                   DisplayUserData userData)

Adds the current record number to the output format buffer for the input DataDir object,

Specified by:

doRule in interface DisplayRule

Parameters:

dir - the DataDir object containing the data record

recordNumber - the record number of the item within the list

ruleSpec - the field specification for locating the data

fmtUtil - the FormatBerUtil object containing the current formatted data buffer and the formatting utilities.

Returns:

userData the DisplayUserData object containing the user's context for formatting the data records.