class: Parameters

public class: Parameters
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:12:20; Modified: 16.07.2009 15:12:20;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {681E8EBF-05B0-46de-BF32-42FC82BACDE0}
 

Goto: Custom Properties, Fields, Methods

See also: LayoutElement, ReportingGUI

Appears in: data

Connections
 
Custom Properties
 
Parameters Attributes
Attribute Details
private static String
  appTable
Initial: { { "validIf", LE_P, LE_Pr, LE_E_LE_P, CS_P, CS_E_LE_P }, { "startsWith", LE_P, LE_Pr, LE_E_LE_P, LE_E_LE_Pr, CS_P, CS_E_LE_P }, { "endsWith", LE_P, LE_Pr, LE_E_LE_P, LE_E_LE_Pr, CS_P, CS_E_LE_P }, { "delimiter", LE_P, LE_Pr, LE_E_LE_P, CS_P, CS_E_LE_P }, { "internalDelimiter", LE_Pr, CS_E_LE_P }, { "fontStyle", LE_P, LE_Pr, LE_E_LE_P, CS_E_LE_P }, { "maxLength", LE_P, LE_Pr, LE_E_LE_P, LE_E_LE_Pr, CS_P, CS_E_LE_P }, { "maxLengthEndsWith", LE_P, LE_Pr, LE_E_LE_P, LE_E_LE_Pr, CS_P, CS_E_LE_P }, { "maxCount", LE_Pr, CS_E_LE_P }, { "maxCountEndsWith", LE_Pr, CS_E_LE_P }, { "position", LE_Pr, CS_E_LE_P }, //??? }
Notes: Table of applicability of parameters according to position in data tree TODO: move the stuff to the Schematron
public static const String
  CS_E_LE_P
Initial: "5"
Notes: csLayoutDefinition/elements/layoutElement/parameters
public static const String
  CS_P
Initial: "4"
Notes: csLayoutDefinition/parameters
private String
  delimiter
Notes: delimiter
private String
  endsWith
Notes: endsWith
private String
  fontStyleRef
Notes: reference to the used FontStyle
private String
  internalDelimiter
Notes: internalDelimiter is used in repeatable elements for subelements delimiting
public static const String
  LE_E_LE_P
Initial: "2"
Notes: layoutElement/elements/layoutElement/parameters
public static const String
  LE_E_LE_Pr
Initial: "3"
Notes: layoutElement/elements/layoutElement/parameters (repeatable)
public static const String
  LE_P
Initial: "0"
Notes: layoutElement/parameters
public static const String
  LE_Pr
Initial: "1"
Notes: layoutElement/parameters (repeatable)
private static const Logger
  logger
Initial: Logger.getLogger(Parameters.class)
private int
  maxCount
Notes: is used to limit the number of repeatable elements in output
private String
  maxCountEndsWith
Notes: is used to inform that maxCount is exceeded
private int
  maxLength
Notes: is used to limit the number characters in complete citation
private String
  maxLengthEndsWith
Notes: is used to inform that maxLength is exceeded
private String
  position
Notes: name of position attribute of parameter element
private String
  startsWith
Notes: startsWith
private String
  validIf
Notes: validIf expression
 
Parameters Methods
Operation Details
public
clone():Object
Sequential
public
getDelimiter():String
Sequential
Notes: delimiter getter
@return delimiter
public static
getDigesterRules(
   Digester dig,
   String path):Digester
Sequential
Notes: Creates rules for org.apache.commons.digester.Digester for the instance
@link Parameters} element in {@link CitationStyle} or {@link LayoutElement} tree
@return org.apache.commons.digester.Digester
public
getDomElement(
   Document d):Element
Sequential
Notes: Creates org.w3c.dom.Element for the instance
@return org.w3c.dom.Element
public
getEndsWith():String
Sequential
Notes: endsWith getter
@return endsWith
public
getFontStyleRef():String
Sequential
Notes: fontStyleRef getter
@return fontStyleRef
public
getInternalDelimiter():String
Sequential
Notes: internalDelimiter getter
@return internalDelimiter
public
getMaxCount():int
Sequential
Notes: maxCount getter
@return maxCount
public
getMaxCountEndsWith():String
Sequential
Notes: maxCountEndsWith getter
@return maxCountEndsWith
public
getMaxLength():int
Sequential
Notes: maxLength getter
@return maxLength
public
getMaxLengthEndsWith():String
Sequential
Notes: maxLengthEndsWith getter
@return maxLengthEndsWith
public
getPosition():String
Sequential
Notes: position getter
@return position
public
getStartsWith():String
Sequential
Notes: startsWith getter
@return startsWith
public
getValidIf():String
Sequential
Notes: validIf getter
@return validIf
public static
main(
   String[] args):void
Sequential
Tags: throws=ParserConfigurationException,IOException,CitationStyleManagerException
public
Parameters():
Sequential
Notes: Constructor
public static
paramIsApplicableToLoc(
   String param,
   String loc):boolean
Sequential
Tags: throws=CitationStyleManagerException
Notes: Returns true if parameter is applicable to location in {@link CitationStyle} definition tree TODO: move to the Schematron
@link CitationStyle} definition tree
@return true - if param is applicable to loc, false otherwise
public static
paramsList():String
Sequential
Notes: Gets the list of all available parameters
@return list of parameters' names are available
public
setDefault():void
Sequential
Notes: Sets default parameters. TODO: move to the properties
public
setDelimiter(
   String newDelimiter):void
Sequential
Notes: delimiter setter
public
setEndsWith(
   String newEndsWith):void
Sequential
Notes: endsWith setter
@param newStartsWith
public
setFontStyleRef(
   String newFontStyleRef):void
Sequential
Notes: fontStyleRef setter
public
setInternalDelimiter(
   String newInternalDelimiter):void
Sequential
Notes: internalDelimiter setter
public
setMaxCount(
   int newMaxCount):void
Sequential
Notes: maxCount setter
public
setMaxCountEndsWith(
   String newMaxCountEndsWith):void
Sequential
Notes: maxCountEndsWith setter
public
setMaxLength(
   int newMaxLength):void
Sequential
Notes: maxLength setter
public
setMaxLengthEndsWith(
   String newMaxLengthEndsWith):void
Sequential
Notes: maxLengthEndsWith setter
public
setPosition(
   String newPosition):void
Sequential
Notes: position setter
public
setStartsWith(
   String newStartsWith):void
Sequential
Notes: startsWith setter
public
setValidIf(
   String newValidIf):void
Sequential
Notes: validIf setter-getter
public
toString():String
Sequential