org.docgene.parser

Class HookContext

java.lang.Object

org.docgene.parser.HookContext

public class HookContext
extends java.lang.Object

The context provided to element hooks.

Method Summary

Modifier and Type	Method and Description
void	aborted()
org.docgene.model.XMLParagraph	addParagraph(org.docgene.model.XMLArticle article) Add a paragraph to an arricle.
org.docgene.model.XMLArticle	createArticle(java.lang.String desc) Create an article.
org.docgene.model.XMLArticle	createArticle(java.lang.String id, java.lang.String desc) Create an article.
org.docgene.model.XMLArticle	createArticle(java.lang.String id, java.lang.String desc, boolean keepCase) Create an article.
int	getElementIndex() Return the current element index.
java.util.List<ParagraphElement>	getElementsAfter() Return all the elements after the current element.
java.util.List<ParagraphElement>	getElementsBefore() Return all the elements before the current element.
ArticlesModel	getModel() Return the ArticlesModel.
ParagraphElement	getNextElement() Return the next element after the current element.
ParagraphElement	getPreviousElement() Return the previous element before the current element.
ParagraphElement	getSiblingElement(int elementOffset) Return a sibling element with an offset relative to the current element.
java.lang.String	getSiblingElementTypeDecl(int elementOffset) Return the type declaration of the sibling element with an offset relative to the current element.
boolean	hasNextElement() Return true if there is a next element after the current element.
boolean	hasPreviousElement() Return true if there is a previous element before the current element.
void	insertElementsAfter(ParagraphElement... elements) Insert a list of elements after the current element.
void	insertElementsBefore(ParagraphElement... elements) Insert a list of elements before the current element.
void	removeCurrentElement() Remove the current element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getModel

public ArticlesModel getModel()

Return the ArticlesModel.

Returns:

the ArticlesModel

createArticle

public org.docgene.model.XMLArticle createArticle(java.lang.String desc)

Create an article.

Parameters:

desc - the article description

Returns:

the article

createArticle

public org.docgene.model.XMLArticle createArticle(java.lang.String id,
                                                  java.lang.String desc)

Create an article.

Parameters:

id - the article id (maybe null)

desc - the article description

Returns:

the article

createArticle

public org.docgene.model.XMLArticle createArticle(java.lang.String id,
                                                  java.lang.String desc,
                                                  boolean keepCase)

Create an article.

Parameters:

id - the article id (maybe null)

desc - the article description

keepCase - true if the article description should keep the title description case

Returns:

the article

addParagraph

public org.docgene.model.XMLParagraph addParagraph(org.docgene.model.XMLArticle article)

Add a paragraph to an arricle.

Parameters:

article - the article

Returns:

the paragraph

getElementIndex

public int getElementIndex()

Return the current element index.

Returns:

the current element index

hasPreviousElement

public boolean hasPreviousElement()

Return true if there is a previous element before the current element.

Returns:

true if there is a previous element before the current element

hasNextElement

public boolean hasNextElement()

Return true if there is a next element after the current element.

Returns:

true if there is a next element after the current element

getPreviousElement

public ParagraphElement getPreviousElement()

Return the previous element before the current element.

Returns:

the previous element before the current element

getNextElement

public ParagraphElement getNextElement()

Return the next element after the current element.

Returns:

the next element after the current element

getSiblingElementTypeDecl

public java.lang.String getSiblingElementTypeDecl(int elementOffset)

Return the type declaration of the sibling element with an offset relative to the current element. It will return "none" if the element is null or has no type declaration.

Parameters:

elementOffset - the offset

Returns:

the sibling element type declaration

aborted

public void aborted()

getSiblingElement

public ParagraphElement getSiblingElement(int elementOffset)

Return a sibling element with an offset relative to the current element.

Parameters:

elementOffset - the offset

Returns:

the sibling element

getElementsAfter

public java.util.List<ParagraphElement> getElementsAfter()

Return all the elements after the current element. Note that this list is a copy of the actual list, so changing it will not change the effective list of elements. Use insertElementsAfter(org.docgene.model.ParagraphElement...) if you want to add new elements.

Returns:

all the elements after the current element

getElementsBefore

public java.util.List<ParagraphElement> getElementsBefore()

Return all the elements before the current element. Note that this list is a copy of the actual list, so changing it will not change the effective list of elements.

Returns:

all the elements before the current element

removeCurrentElement

public void removeCurrentElement()

Remove the current element.

insertElementsAfter

public void insertElementsAfter(ParagraphElement... elements)

Insert a list of elements after the current element.

Parameters:

elements - the list of elements

insertElementsBefore

public void insertElementsBefore(ParagraphElement... elements)

Insert a list of elements before the current element.

Parameters:

elements - the list of elements