fr.opensagres.xdocreport.document.odt.preprocessor

Class ODTAnnotationParsingHelper

java.lang.Object

fr.opensagres.xdocreport.document.odt.preprocessor.ODTAnnotationParsingHelper

public class ODTAnnotationParsingHelper
extends java.lang.Object

ODT annotation handler. Functions:

• safe iterate over blok: table:table-row, text:list-item, text:section, using @before#foreach()$after#end syntax
• safe replace range annotations with annotation content
• annotation content is treated as simple unformatted text

Created on 2018-07-06

Version:

$Id$

Author:

Marcin Golebski

Constructor Summary

Constructors

Constructor and Description
ODTAnnotationParsingHelper()

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String value) Append new string into annotation content.
java.lang.String	getAfter() Returns "after" part of annotation content.
java.lang.String	getBefore() Returns "before" part of annotation content.
java.util.List<java.lang.String>	getParents() Return type of parrents which are itrable using point-annotation.
java.lang.String	getReplacement() Returns "replacement" part of annotation content.
boolean	hasAfter() Check if annotation has "after" part.
boolean	hasBefore() Check if annotation has "before" part.
boolean	hasReplacement() Check if annotation has "replacement" part.
boolean	isNotReplacedYet() Check if in case of range annotation replacement has been already done.
boolean	isParsing() The annotation tag is parsing now.
boolean	isRangeAnnotation() Check if this anotation is "point" or "range" anotation.
boolean	isTheSameBlock(int currentElementIndex) Check if index of current element shows we are in the same block like anotation is.
boolean	resetRangeAnnotation(java.lang.String name, boolean force) Close range annotation.
void	setCurrentElement(java.lang.String uri, java.lang.String localName, java.lang.String name) Inform this helper which component is parsed now.
void	setParsingBegin(java.lang.String name, int index) Set the helper in the state of parsing annotation tag content.
void	setParsingEnd()
void	setReplacementDone() Should be executed, when range annotation replacemen is done.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODTAnnotationParsingHelper

public ODTAnnotationParsingHelper()

Method Detail

isParsing

public boolean isParsing()

The annotation tag is parsing now.

Returns:

true if annotation tag is parsing now, false otherwise

setCurrentElement

public void setCurrentElement(java.lang.String uri,
                              java.lang.String localName,
                              java.lang.String name)

Inform this helper which component is parsed now.

Parameters:

uri -

localName -

name -

setParsingBegin

public void setParsingBegin(java.lang.String name,
                            int index)

Set the helper in the state of parsing annotation tag content.

Parameters:

name - the name of the annotation. Not null when annotation has end element somewere in document

index - index of the annotation element. It is used to close replacement block in proper place (replacement block is not allowed to span over the end of enclosed tag)

setParsingEnd

public void setParsingEnd()

resetRangeAnnotation

public boolean resetRangeAnnotation(java.lang.String name,
                                    boolean force)

Close range annotation.

Parameters:

name - the name of the range annotation

force - if true block will be closed even if name does not match

Returns:

true if the name is the name of the first oppened annotation, false otherwise

append

public void append(java.lang.String value)

Append new string into annotation content.

Parameters:

value - the value being appended

getParents

public java.util.List<java.lang.String> getParents()

Return type of parrents which are itrable using point-annotation.

Returns:

the list of tag names

hasBefore

public boolean hasBefore()

Check if annotation has "before" part.

Returns:

true if annotation has "before" part, false otherwise

getBefore

public java.lang.String getBefore()

Returns "before" part of annotation content.

Returns:

"before" part

hasAfter

public boolean hasAfter()

Check if annotation has "after" part.

Returns:

true if annotation has "after" part, false otherwise

getAfter

public java.lang.String getAfter()

Returns "after" part of annotation content.

Returns:

"after" part

hasReplacement

public boolean hasReplacement()

Check if annotation has "replacement" part.

Returns:

true if annotation has "replacement" part, false otherwise

getReplacement

public java.lang.String getReplacement()

Returns "replacement" part of annotation content.

Returns:

"replacement" part

isRangeAnnotation

public boolean isRangeAnnotation()

Check if this anotation is "point" or "range" anotation.

Returns:

true if this is range annotation, false otherwise

isTheSameBlock

public boolean isTheSameBlock(int currentElementIndex)

Check if index of current element shows we are in the same block like anotation is. It is used to check if we should force to close range annotation which is setup across many tags.

Parameters:

currentElementIndex - the index of current tag

Returns:

true if current tag is the same container like anotation is, false otherwise

isNotReplacedYet

public boolean isNotReplacedYet()

Check if in case of range annotation replacement has been already done.

Returns:

true when replacement has been already performed, false otherwise

setReplacementDone

public void setReplacementDone()

Should be executed, when range annotation replacemen is done. It prevents unwanted multiple relacement when several containers is present in annotation range.