ORG.oclc.fmts.rules
Class AddFetchAnchor

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

public class AddFetchAnchor

extends RuleUtil

implements DisplayRule

The AddFetchAnchor class is a record formatting rule that creates a FETCH hot-link for the input fields. 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:

command

The FETCH command where the default, if not specified, is &StyleTable.defaults.FETCHCommand;.

nextPage

The next= page in the anchor, where the default, if not specified, is &StyleTable.pages.fulldisplay;.

badPage

The bad= page in the anchor, where the default, if not specified, is &StyleTable.pages.badfetch;.

format

The format= value in the anchor, where the default, if not specified, is F.

numrecs

The numrecs= value in the anchor, where the default, if not specified, is to omit the parameter.

otherWidgets

Any additional name/value pairs to add to the FETCH request, where the default, if not specified, is to omit the parameter.

target

The target value for the anchor where the default, if not specified, is null.

linkInfo

The overriding data to display for the link other than the text data in the fields specified in the parameters, such as a gif.

missingData

The string to use when the data in the specified fields is not located and the linkInfo parameter is not specified, such as 'No Title Provided', so the anchor can still be created.

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 beforeFETCHAnchor.

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 afterFETCHAnchor.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddFetchAnchor()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates a FETCH hot-link for the input record based on the fields specified in the RuleSpec object and appends it to the formatting buffer held in the input FormatBerUtil 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

AddFetchAnchor

public AddFetchAnchor()

Method Detail

doRule

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

Creates a FETCH hot-link for the input record based on the fields specified in the RuleSpec object and appends it to the formatting buffer held in the input FormatBerUtil 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.

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