Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.rules
Class AddHTTPAnchor

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

public class AddHTTPAnchor
extends RuleUtil
implements DisplayRule

The AddHTTPAnchor class is a record formatting rule that creates an HTTP (http://) 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 additional parameters this rule recognizes are:

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.

See Also:
RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary
AddHTTPAnchor()
           
 
Method Summary
 void doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData)
          Creates an HTTP:// 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

AddHTTPAnchor

public AddHTTPAnchor()
Method Detail

doRule

public void doRule(DataDir dir,
                   int recordNumber,
                   RuleSpec ruleSpec,
                   FormatBerUtil fmtUtil,
                   DisplayUserData userData)
Creates an HTTP:// 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.

Open SiteSearch 4.1.1
Final