ORG.oclc.fmts.rules
Class AddFullTextButton

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

public class AddFullTextButton

extends RuleUtil

implements DisplayRule

The AddFullTextButton class is a record formatting rule that creates a FETCH hot-link to display Full-Text for a record when the data in the input field matches the data specified as the the matching criteria. 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 this rule recognizes are:

matchingString

The string to compare the field data to in order to determine whether the anchor should be created. This is a required parameter

matchCriteria

this determines what type of match to look for:

• STARTSWITH indicates that the field data should start with the matchingString
• ENDSWITH indicates that the field data should end with the matchingString
• EQUALS indicates that the field data should equal the matchingString. The default setting
• NOTEQUALS indicates that the field data should NOT equal the matchingString
• HAS indicates that the field should contain anywhere, the matching string

caseSensitive

a true/false flag indicating whether the case of the data should be ignored where the default is false(case insensitive).

displayFieldData

value indicating where to display the data from the field where the accepted settings are:

• BEFORE indicates that the data from the field gets stored in the format buffer first, then the anchor if matches.
• AFTER indicates that the anchor is created, then the data from the field gets stored in the format buffer.
• NO indicates that only the anchor is created if it matches the criteria.

beforeLabelWrapperName

The name of the data wrapper entry that has the string to append before the field display label, default, if not specified, is the wrapper element named beforeFieldLabel.

afterLabelWrapperName

The name of the data wrapper entry that has the string to append after the field display label, where the default, if not specified, is the wrapper element named afterFieldLabel.

fieldTrailerWrapperName

The name of the data wrapper entry that has the string to append after the field data, where the default, if not specified, is the wrapper element named fieldTrailer.

beforeAnchorWrapperName

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

afterAnchorWrapperName

The name of the data wrapper entry that has the string to append after the anchor where the default, if not specified, is the wrapper element named afterFTAnchor.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddFullTextButton()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates a FETCH hot-link to display Full-Text for the input record based on the fields specified in the RuleSpec object and the matching criteria specified in the rules parameters.

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

AddFullTextButton

public AddFullTextButton()

Method Detail

doRule

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

Creates a FETCH hot-link to display Full-Text for the input record based on the fields specified in the RuleSpec object and the matching criteria specified in the rules parameters.

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.