Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.rules
Class AddWrapperData

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

public class AddWrapperData
extends RuleUtil
implements DisplayRule

The AddWrapperData class is a record formatting rule that appends the wrapper data item to the output formatting buffer.

The parameter this rule recognizes is:

wrapperName
The name of the wrapper data item to retrieve from the input data wrappers and append to the output

See Also:
RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary
AddWrapperData()
           
 
Method Summary
 void doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData)
          Appends the wrapper data specified in the 'wrapper name' rule parameter to the formatted data buffer.
 
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

AddWrapperData

public AddWrapperData()
Method Detail

doRule

public void doRule(DataDir dir,
                   int recordNumber,
                   RuleSpec ruleSpec,
                   FormatBerUtil fmtUtil,
                   DisplayUserData userData)
Appends the wrapper data specified in the 'wrapper name' rule parameter to the formatted data buffer.
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.
userData - the DisplayUserData object containing the user's context for formatting the data records.

Open SiteSearch 4.1.1
Final