class: CitationStyle

public class: CitationStyle
Author: vmakarenko (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2110 $ $LastChangedDate: 2009-06-18 17:; Complexity: 1
Dates: Created: 16.07.2009 15:12:18; Modified: 16.07.2009 15:12:18;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {1EB54E00-CE56-470f-94A4-3BC836E9ADB4}
An instance of this class represents a CitationStyle
 

Goto: Custom Properties, Fields, Methods

See also: LayoutElementsCollection, ReportingGUI, ReportingGUI, ReportingGUI

Appears in: data

Connections
 
Custom Properties
 
CitationStyle Attributes
Attribute Details
private List
  csLayoutDefinitions
Notes: Ordered list of LayoutElements which definred Citation Styles Layout Defifintions
private boolean
  elementSpecific
Notes: String value of @ref
private boolean
  hasName
Notes: triger is set to true if document has defined name
private LayoutElementsCollection
  layoutElements
Notes: globally defined layoutElements on the citation style level
private static const Logger
  logger
Initial: Logger.getLogger(CitationStyle.class)
private String
  mdXPath
Notes: Medatata root xpath
private String
  name
Notes: Name of CS
private boolean
  readOnly
Notes: CS can be overridden
private LinkedHashMap
  variables
Notes: special variables to be used in CitationStyle
 
CitationStyle Methods
Operation Details
public
addCsLayoutDefinition(
   LayoutElement csld):void
Sequential
Notes: Adds Citation Style Layout Definition (csld) to the list <code>csLayoutDefinitions</code> in case if there is no csld with the same name
@link LayoutElement}
public
addLayoutElement(
   LayoutElement le):void
Sequential
Notes: add layout element to the special collection of predefined layout elements
public
addVariable(
   String name,
   String type,
   String expression):void
Sequential
public
CitationStyle():
Sequential
Notes: Constructor
public
clone():Object
Sequential
public
fillEmptyNames(
   String prefix):void
Sequential
Notes: Fills empty names of <code>csLayoutDefinitions</code> with uniq name
public
generateIDs(
   String prefix):void
Sequential
Notes: Generates internal Ids for all <code>cs-layout-definition</code>s in the Citation Style
public
getCsLayoutDefinitions():List
Sequential
public
getDomElement(
   Document d):Element
Sequential
Notes: Creates Element for CitationStyle class
@return Element
public
getElementById(
   String id):LayoutElement
Sequential
Notes: Searches {@link LayoutElement} by <code>id</code> in complete <code>csLayoutDefinitions</code> list.
@return {@link LayoutElement}
public
getElementByName(
   String name):LayoutElement
Sequential
Notes: Searches {@link LayoutElement} by name in complete <code>csLayoutDefinitions</code> list.
@return {@link LayoutElement}
public
getElementSpecific():boolean
Sequential
public
getLayoutElements():LayoutElementsCollection
Sequential
public
getMdXPath():String
Sequential
public
getName():String
Sequential
public
getReadOnly():boolean
Sequential
public
getVariables():LinkedHashMap
Sequential
public static
main(
   String[] args):void
Sequential
public
replaceCsldByNameWith(
   String name,
   LayoutElement le):LayoutElement
Sequential
Notes: Replaces the element in <code>csLayoutDefinitions</code> list with the specified element <code>le</code>.
@return the replaced element or <code>null</code> if no element has been found
public
setCsLayoutDefinitions(
   List newCsLayoutDefinitions):void
Sequential
public
setDefault():void
Sequential
Notes: Default values definition
public
setElementSpecific(
   boolean newElementSpecific):void
Sequential
public
setLayoutElements(
   LayoutElementsCollection layoutElements):void
Sequential
public
setMdXPath(
   String mdXPath):void
Sequential
public
setName(
   String newName):void
Sequential
public
setReadOnly(
   boolean newReadOnly):void
Sequential
public
setVariables(
   LinkedHashMap variables):void
Sequential
public
toString():String
Sequential