net.sf.layoutParser.processor

Interface LayoutProcessor

All Known Implementing Classes:

ClassicLayoutProcessor, CsvLayoutProcessor

public interface LayoutProcessor

Layout processors handle the job of transform an domain objects to formated string to be written to files and the extraction of data from the strings and populate the domain objects.

Since:

Author:

Leonardo Bueno Postacchini

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Map<String,Object> data) Format the data to its string format so it can be written out.
String	format(Object obj) Format the data to its string format so it can be written out.
Map<String,Object>	parse(Reader registry) Read data from the reader formatting it according to the layout.
<T> T	parse(Reader registry, T obj) Read data from the reader formatting it according to the layout, and return the appropriate object populated.
void	setLayout(LayoutTO layout) Allow configure the processor with a layout.
void	validate(LayoutTO layout) Allow the processor to validate the layout item according to its own specific rules.

Method Detail

format

String format(Map<String,Object> data)
              throws LayoutException

Format the data to its string format so it can be written out.

Parameters:

data - The data to be formated.

Returns:

The formated data.

Throws:

LayoutException

Since:

1.0

parse

Map<String,Object> parse(Reader registry)
                         throws LayoutException

Read data from the reader formatting it according to the layout.

Parameters:

registry - The source of the data to be read and parsed.

Returns:

A data map resulting from the parsing.

Throws:

LayoutException

IOException

Since:

1.0

parse

<T> T parse(Reader registry,
          T obj)
        throws LayoutException

Read data from the reader formatting it according to the layout, and return the appropriate object populated.

Parameters:

registry - The data source.

obj - The object to be populated.

Returns:

The populated object.

Throws:

LayoutException

format

String format(Object obj)
              throws LayoutException

Format the data to its string format so it can be written out.

Parameters:

obj - The object to be written.

Returns:

The string formatted according to the layout.

Throws:

LayoutException

setLayout

void setLayout(LayoutTO layout)

Allow configure the processor with a layout.

Parameters:

layout - The layout to be used with the processor.

validate

void validate(LayoutTO layout)
              throws LayoutException

Allow the processor to validate the layout item according to its own specific rules.

Parameters:

layout -

Throws:

LayoutException