fr.opensagres.xdocreport.template.formatter
Class FieldsMetadata

java.lang.Object
  fr.opensagres.xdocreport.template.formatter.FieldsMetadata

public class FieldsMetadata
extends Object

Fields Metadata is used in the preprocessing step to modify some XML entries like generate script (Freemarker, Velocity...) for loop for Table row, generate script for Image...

Field Summary

static String	DEFAULT_AFTER_ROW_TOKEN
static String	DEFAULT_AFTER_TABLE_CELL_TOKEN
static String	DEFAULT_BEFORE_ROW_TOKEN
static String	DEFAULT_BEFORE_TABLE_CELL_TOKEN
static FieldsMetadata	EMPTY

Constructor Summary

FieldsMetadata()

FieldsMetadata(IFieldsMetadataClassSerializer serializer)

FieldsMetadata(String templateEngineKind)

Method Summary

void	addField(String fieldName, boolean listType, String imageName, String syntaxKind)
void	addFieldAsImage(String fieldName) Add a field name which is considered as an image.
void	addFieldAsImage(String imageName, String fieldName) Add a field name which is considered as an image.
void	addFieldAsList(String fieldName) Add a field name which belongs to a list.
void	addFieldAsTextStyling(String fieldName, String syntaxKind) Add a field name which can contains text stylink (Html, Wikipedia, etc..).
void	addFieldAsTextStyling(String fieldName, SyntaxKind syntaxKind) Add a field name which can contains text stylink (Html, Wikipedia, etc..).
String	getAfterRowToken()
String	getAfterTableCellToken()
String	getBeforeRowToken()
String	getBeforeTableCellToken()
List<FieldMetadata>	getFields() Returns list of fields metadata.
Collection<FieldMetadata>	getFieldsAsImage() Returns list of fields name which are considered as an image.
Collection<String>	getFieldsAsList() Returns list of fields name which belongs to a list.
Collection<FieldMetadata>	getFieldsAsTextStyling() Returns list of fields name which can contains text styling.
String	getImageFieldName(String fieldName)
boolean	hasFieldsAsImage() Returns true if there are fields as image and false otherwise.
boolean	isFieldAsImage(String fieldName)
void	load(FieldsMetadata fieldsMetadata, String key, Class<?> clazz) Load simple fields metadata in the given fieldsMetadata by using the given key and Java Class.
void	load(FieldsMetadata fieldsMetadata, String key, Class<?> clazz, boolean listType) Load simple/list fields metadata in the given fieldsMetadata by using the given key and Java Class.
void	loadXML(Reader reader) Load fields metadata from the given XML reader.
void	saveXML(Writer writer) Serialize as XML without indentation the fields metadata to the given XML writer.
void	saveXML(Writer writer, boolean indent) Serialize as XML the fields metadata to the given XML writer.
void	setAfterRowToken(String afterRowToken)
void	setAfterTableCellToken(String afterTableCellToken)
void	setBeforeRowToken(String beforeRowToken)
void	setBeforeTableCellToken(String beforeTableCellToken)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final FieldsMetadata EMPTY

DEFAULT_BEFORE_ROW_TOKEN

public static final String DEFAULT_BEFORE_ROW_TOKEN

See Also:

Constant Field Values

DEFAULT_AFTER_ROW_TOKEN

public static final String DEFAULT_AFTER_ROW_TOKEN

See Also:

Constant Field Values

DEFAULT_BEFORE_TABLE_CELL_TOKEN

public static final String DEFAULT_BEFORE_TABLE_CELL_TOKEN

See Also:

Constant Field Values

DEFAULT_AFTER_TABLE_CELL_TOKEN

public static final String DEFAULT_AFTER_TABLE_CELL_TOKEN

See Also:

Constant Field Values

Constructor Detail

FieldsMetadata

public FieldsMetadata()

FieldsMetadata

public FieldsMetadata(String templateEngineKind)

FieldsMetadata

public FieldsMetadata(IFieldsMetadataClassSerializer serializer)

Method Detail

addFieldAsImage

public void addFieldAsImage(String fieldName)

Add a field name which is considered as an image.

Parameters:

fieldName -

addFieldAsImage

public void addFieldAsImage(String imageName,
                            String fieldName)

Add a field name which is considered as an image.

Parameters:

imageName -

fieldName -

addFieldAsTextStyling

public void addFieldAsTextStyling(String fieldName,
                                  SyntaxKind syntaxKind)

Add a field name which can contains text stylink (Html, Wikipedia, etc..).

Parameters:

fieldName -

syntaxKind -

addFieldAsTextStyling

public void addFieldAsTextStyling(String fieldName,
                                  String syntaxKind)

Add a field name which can contains text stylink (Html, Wikipedia, etc..).

Parameters:

fieldName -

syntaxKind -

addFieldAsList

public void addFieldAsList(String fieldName)

Add a field name which belongs to a list.

Parameters:

fieldName -

addField

public void addField(String fieldName,
                     boolean listType,
                     String imageName,
                     String syntaxKind)

getFieldsAsList

public Collection<String> getFieldsAsList()

Returns list of fields name which belongs to a list.

Returns:

getFieldsAsImage

public Collection<FieldMetadata> getFieldsAsImage()

Returns list of fields name which are considered as an image.

Returns:

getFieldsAsTextStyling

public Collection<FieldMetadata> getFieldsAsTextStyling()

Returns list of fields name which can contains text styling.

Returns:

hasFieldsAsImage

public boolean hasFieldsAsImage()

Returns true if there are fields as image and false otherwise.

Returns:

isFieldAsImage

public boolean isFieldAsImage(String fieldName)

getImageFieldName

public String getImageFieldName(String fieldName)

getBeforeRowToken

public String getBeforeRowToken()

setBeforeRowToken

public void setBeforeRowToken(String beforeRowToken)

getAfterRowToken

public String getAfterRowToken()

setAfterRowToken

public void setAfterRowToken(String afterRowToken)

getBeforeTableCellToken

public String getBeforeTableCellToken()

setBeforeTableCellToken

public void setBeforeTableCellToken(String beforeTableCellToken)

getAfterTableCellToken

public String getAfterTableCellToken()

setAfterTableCellToken

public void setAfterTableCellToken(String afterTableCellToken)

getFields

public List<FieldMetadata> getFields()

Returns list of fields metadata.

Returns:

loadXML

public void loadXML(Reader reader)

Load fields metadata from the given XML reader. Here a sample of XML reader :

Parameters:

reader -

saveXML

public void saveXML(Writer writer)
             throws IOException

Serialize as XML without indentation the fields metadata to the given XML writer. Here a sample of XML writer :

Parameters:

writer -

Throws:

IOException

saveXML

public void saveXML(Writer writer,
                    boolean indent)
             throws IOException

Serialize as XML the fields metadata to the given XML writer. Here a sample of XML writer :

Parameters:

writer - XML writer.

indent - true if indent must be managed and false otherwise.

Throws:

IOException

load

public void load(FieldsMetadata fieldsMetadata,
                 String key,
                 Class<?> clazz)

Load simple fields metadata in the given fieldsMetadata by using the given key and Java Class.

Parameters:

fieldsMetadata - the fieldsMetadata where fields metadata must be added.

key - the key (first token) to use to generate field name.

clazz - the Java class model to use to load fields metadata.

load

public void load(FieldsMetadata fieldsMetadata,
                 String key,
                 Class<?> clazz,
                 boolean listType)

Load simple/list fields metadata in the given fieldsMetadata by using the given key and Java Class.

Parameters:

fieldsMetadata - the fieldsMetadata where fields metadata must be added.

key - the key (first token) to use to generate field name.

clazz - the Java class model to use to load fields metadata.

listType - true if it's a list and false otherwise.

toString

public String toString()

Overrides:

toString in class Object