com.highqsoft.querytree

Class MessageFormatter

java.lang.Object

com.highqsoft.querytree.MessageFormatter

All Implemented Interfaces:

FormatterIF

public class MessageFormatter
extends java.lang.Object
implements FormatterIF

This is the formatter assigned by the XML messageformatter tag. It uses the definition from java.text.MessageFormat class.

Since:

$Date: 2017/04/06 13:30:27 $

Version:

$Revision: 1.8 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Constructor Summary

Constructors

Constructor and Description
MessageFormatter(XSDContextIF ctx, Formatvalue messageFormat, int maxRows) Create the object.
MessageFormatter(XSDContextIF ctx, java.lang.String messageFormat, java.lang.String terminator, int maxRows) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the formatter.
java.util.Iterator<java.lang.String>	format(ResultIF result) Get the formatted string of the given result set structure.
java.lang.String	getTerminator() Get the terminator string.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageFormatter

public MessageFormatter(XSDContextIF ctx,
                Formatvalue messageFormat,
                int maxRows)

Create the object.

Parameters:

ctx - the context.

messageFormat - the message format descriptor.

maxRows - the maximum number of rows to be formatted. if 0 the formatter will format all rows.

MessageFormatter

public MessageFormatter(XSDContextIF ctx,
                java.lang.String messageFormat,
                java.lang.String terminator,
                int maxRows)

Create the object.

Parameters:

ctx - the context.

messageFormat - the message format string.

termintator - the terminator string.

maxRows - the total number of rows.

Method Detail

close

public void close()

Close the formatter.

Specified by:

close in interface FormatterIF

format

public java.util.Iterator<java.lang.String> format(ResultIF result)

Get the formatted string of the given result set structure.

Specified by:

format in interface FormatterIF

Parameters:

result - the query result.

Returns:

the iterator containing the output string.

getTerminator

public java.lang.String getTerminator()

Get the terminator string.

Specified by:

getTerminator in interface FormatterIF

Returns:

the terminator string.