edu.northwestern.at.wordhoard.tools.cm
Class Rules

java.lang.Object
  extended by edu.northwestern.at.wordhoard.tools.cm.Rules

public class Rules
extends java.lang.Object

Rules.


Constructor Summary
Rules(java.lang.String path)
          Creates a new rules object.
 
Method Summary
 java.util.List getAuthors(org.w3c.dom.Document document, java.lang.String fileName)
          Gets the authors.
 java.lang.String getCorpusTag()
          Gets the corpus tag.
 Style getFootnoteReferenceStyle()
          Gets the footnote reference style.
 Style getFootnoteStyle()
          Gets the footnote style.
 java.util.Map getHeaderValues(org.w3c.dom.Document document, java.lang.String fileName)
          Gets the work header values.
 Style getRendAttributeStyle(org.w3c.dom.Element el)
          Gets the style for a rend attribute.
 TextElementRule getTextElementRule(org.w3c.dom.Element el)
          Gets a text element rule.
 java.lang.String getTextPath()
          Gets the text path.
 TitlePageRules getTitlePageRules()
          Gets the title page rules.
 java.lang.String getWorkPartTitle(org.w3c.dom.Element el)
          Gets a work part title.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Rules

public Rules(java.lang.String path)
      throws java.lang.Exception
Creates a new rules object.

Parameters:
path - Path to XML parameters file.
Throws:
java.lang.Exception
Method Detail

getCorpusTag

public java.lang.String getCorpusTag()
Gets the corpus tag.

Returns:
The corpus tag.

getTitlePageRules

public TitlePageRules getTitlePageRules()
Gets the title page rules.

Returns:
The title page rules.

getHeaderValues

public java.util.Map getHeaderValues(org.w3c.dom.Document document,
                                     java.lang.String fileName)
Gets the work header values.

Parameters:
document - XML document.
fileName - File name.
Returns:
Header value map. Maps the names of WordHoard header items to their values.

getAuthors

public java.util.List getAuthors(org.w3c.dom.Document document,
                                 java.lang.String fileName)
Gets the authors.

Parameters:
document - XML document.
fileName - File name.
Returns:
List of authors.

getTextPath

public java.lang.String getTextPath()
Gets the text path.

Returns:
The text path.

getTextElementRule

public TextElementRule getTextElementRule(org.w3c.dom.Element el)
Gets a text element rule.

Parameters:
el - Element.
Returns:
Text element rule, or null if none.

getWorkPartTitle

public java.lang.String getWorkPartTitle(org.w3c.dom.Element el)
Gets a work part title.

Parameters:
el - Element.
Returns:
Work part title.

getRendAttributeStyle

public Style getRendAttributeStyle(org.w3c.dom.Element el)
Gets the style for a rend attribute.

Parameters:
el - Element.
Returns:
Style, or null if none.

getFootnoteReferenceStyle

public Style getFootnoteReferenceStyle()
Gets the footnote reference style.

Returns:
The footnote reference style.

getFootnoteStyle

public Style getFootnoteStyle()
Gets the footnote style.

Returns:
The footnote style.