ORG.oclc.fmts.rules
Class SaveImageInfo

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

public class SaveImageInfo

extends RuleUtil

implements DisplayRule

The SaveImageInfo class is a record formatting rule that creates all the information necessary to navigate an image record created by the ISP package and saves it in the UserStateObject.

The additional parameter this rule recognizes is:

titleFields

The field list defining where the title resides in the document.

recordInfoFields

The field list defining where the additional citation information in the record resides that could be displayed on the image screen to give citation information.

pathToImages

The field list defining the path where the images can be located where the default, if not specified, is 5/1/3/* which is the ISP location of the images.

ImageRootPath

The root path to where the images are located, this can be a fully qualified local pathname on the system or a relative path from the document root or a fixed http:// path.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

SaveImageInfo()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates the ImageInfo for the record for image display for the document.

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

SaveImageInfo

public SaveImageInfo()

Method Detail

doRule

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

Creates the ImageInfo for the record for image display for the document.

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.