com.highqsoft.xsd

Class DefaultResultSetPrinter

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.DefaultResultSetPrinter

All Implemented Interfaces:

ImplementationIF, ResultSetPrinterIF

Direct Known Subclasses:

PlainResultSetPrinter

public class DefaultResultSetPrinter
extends AbstractImplementation
implements ResultSetPrinterIF

The Result set printer.

Since:

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

Version:

$Revision: 1.32 $

Author:

Andreas Hofmann

See Also:

ResultSetPrinterIF

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultResultSetPrinter.ResultColumn The result column.

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	charWidth The char width of the columns
protected int	columnCount The total number of columns.
protected DefaultFormatToString	defaultFormatToString The default formatter.
protected static int	MAXLEN
protected static java.lang.String	SPACES
protected java.lang.Object[]	stringVal The column string presentation.

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
DefaultResultSetPrinter() The default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	findColumn(ApplicationStructure asObj, ResultSetExt[] resultSet, java.lang.String name) Find a specific column.
T_LONGLONG[]	getAIds(ApplicationStructure asObj, ResultSetExt[] resultSet) Get all the application element ids of the columns.
protected NameValueSeqUnitId	getAttributeRestValues(ResultSetExt[] resultSet, int column)
protected NameValueSeqUnitId	getAttributeValues(ResultSetExt[] resultSet, int column) Get the attribute values.
java.lang.String	getCellStringValue(ApplicationStructure asObj, ResultSetExt[] resultSet, int column, int row, FormatToStringIF format) Get the cell string value.
int	getColumnCount(ResultSetExt[] resultSet) Get the column count.
int	getColumnDisplaySize(ApplicationStructure asObj, ResultSetExt[] resultSet, int column, FormatToStringIF format) Indicates the designated column's normal maximum width in characters.
java.lang.String[]	getColumnStringValue(ApplicationStructure asObj, ResultSetExt[] resultSet, int column, FormatToStringIF format) Get the column string value.
DefaultResultSetPrinter.ResultColumn[]	getResultColumns(ApplicationStructure asObj, ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats) Get the result columns.
int	getRowCount(ApplicationStructure asObj, ResultSetExt[] resultSet, java.util.List<FormatToStringIF> formats) Get the row count.
java.lang.String[]	getRowStringValue(ApplicationStructure asObj, ResultSetExt[] resultSet, int row, FormatToStringIF format) Get the row string value.
java.lang.String	getUnitString(ApplicationStructure asObj, T_LONGLONG unitID) Get the unit string of the instan ce element with the given Id.
void	init() Initialize the program.
protected boolean	isNumeric(NameValueSeqUnitId values) Return a boolean whether the value is numeric.
protected boolean	isNumeric(ResultSetExt[] resultSet, int column) Return a boolean whether the value is numeric.
java.lang.String[]	listColumns(ApplicationStructure asObj, ResultSetExt[] resultSet, java.util.List<java.lang.String> alias) List attribute names belong to the result set.
static void	print(java.io.PrintStream out, ApplicationStructure asObj, ResultSetExt[] resultSet) Use this static method to print your result set.
void	print(java.io.PrintStream out, ApplicationStructure asObj, ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats, java.lang.String prefix, java.lang.String postfix) Print out.
void	print(java.io.PrintStream out, ApplicationStructure asObj, ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, java.lang.String prefix, java.lang.String postfix) Print out.
java.lang.String[]	ts_UnionSeqToString(ApplicationStructure asObj, T_LONGLONG aid, NameValueSeqUnitId nvuSeq, java.lang.String format) Get the column string value.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

SPACES

protected static final java.lang.String SPACES

MAXLEN

protected static final int MAXLEN

See Also:

Constant Field Values

charWidth

protected int[] charWidth

The char width of the columns

stringVal

protected java.lang.Object[] stringVal

The column string presentation.

columnCount

protected int columnCount

The total number of columns.

defaultFormatToString

protected DefaultFormatToString defaultFormatToString

The default formatter.

Constructor Detail

DefaultResultSetPrinter

public DefaultResultSetPrinter()

The default constructor.

Method Detail

init

public void init()
          throws InitializationFailedException

Initialize the program.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

getResultColumns

public DefaultResultSetPrinter.ResultColumn[] getResultColumns(ApplicationStructure asObj,
                                                      ResultSetExt[] resultSet,
                                                      java.util.List<java.lang.String> alias,
                                                      java.util.List<FormatToStringIF> formats)
                                                        throws AoException

Get the result columns.

Parameters:

asObj - the application structure

resultSet - the result set.

alias - the list that holds the aliases of the column names.

Returns:

the result columns.

Throws:

AoException

listColumns

public java.lang.String[] listColumns(ApplicationStructure asObj,
                             ResultSetExt[] resultSet,
                             java.util.List<java.lang.String> alias)
                               throws AoException

List attribute names belong to the result set.

Parameters:

asObj - the application structure

resultSet - the result set.

Returns:

The array containing the matched column names.

Throws:

AoException

getAIds

public T_LONGLONG[] getAIds(ApplicationStructure asObj,
                   ResultSetExt[] resultSet)
                     throws AoException

Get all the application element ids of the columns.

Parameters:

asObj - the application structure

resultSet - the result set.

Throws:

AoException

findColumn

public int findColumn(ApplicationStructure asObj,
             ResultSetExt[] resultSet,
             java.lang.String name)
               throws java.lang.Exception

Find a specific column.

Parameters:

asObj - the application structure

resultSet - the result set.

name - the name of the column.

Returns:

the index of the column. The method returns -1 if no column was found.

Throws:

java.lang.Exception

getColumnDisplaySize

public int getColumnDisplaySize(ApplicationStructure asObj,
                       ResultSetExt[] resultSet,
                       int column,
                       FormatToStringIF format)
                         throws AoException

Indicates the designated column's normal maximum width in characters.

Parameters:

resultSet - the result set.

column - The column index.

Returns:

the width in characters of 0 if column doesn't exist.

Throws:

AoException

getRowStringValue

public java.lang.String[] getRowStringValue(ApplicationStructure asObj,
                                   ResultSetExt[] resultSet,
                                   int row,
                                   FormatToStringIF format)
                                     throws AoException

Get the row string value.

Parameters:

resultSet - the result set.

row - The row index.

Returns:

the string array containing the row string presentation.

Throws:

AoException

getCellStringValue

public java.lang.String getCellStringValue(ApplicationStructure asObj,
                                  ResultSetExt[] resultSet,
                                  int column,
                                  int row,
                                  FormatToStringIF format)
                                    throws AoException

Get the cell string value.

Parameters:

resultSet - the result set.

column - The column index.

row - The row index.

Returns:

the string containing the cell string presentation.

Throws:

AoException

getColumnStringValue

public java.lang.String[] getColumnStringValue(ApplicationStructure asObj,
                                      ResultSetExt[] resultSet,
                                      int column,
                                      FormatToStringIF format)
                                        throws AoException

Get the column string value.

Parameters:

resultSet - the result set.

column - The column index.

Returns:

the string array containing the column string presentation.

Throws:

AoException

getUnitString

public java.lang.String getUnitString(ApplicationStructure asObj,
                             T_LONGLONG unitID)

Get the unit string of the instan ce element with the given Id.

Parameters:

asObj - the applciation structure

unitID - the unit Id.

Returns:

the name of the unit or an empty string.

ts_UnionSeqToString

public java.lang.String[] ts_UnionSeqToString(ApplicationStructure asObj,
                                     T_LONGLONG aid,
                                     NameValueSeqUnitId nvuSeq,
                                     java.lang.String format)
                                       throws AoException

Get the column string value.

Parameters:

unionSeq - the sequence of union of the column data.

Returns:

the string array containing the column string presentation.

Throws:

AoException

isNumeric

protected boolean isNumeric(NameValueSeqUnitId values)
                     throws AoException

Return a boolean whether the value is numeric.

Throws:

AoException

isNumeric

protected boolean isNumeric(ResultSetExt[] resultSet,
                int column)
                     throws AoException

Return a boolean whether the value is numeric.

Throws:

AoException

getAttributeValues

protected NameValueSeqUnitId getAttributeValues(ResultSetExt[] resultSet,
                                    int column)
                                         throws AoException

Get the attribute values.

Parameters:

resultSet - the result set.

column - The column index.

Returns:

the attribute values. The return value is castable to NameValueSeqUnitId[]

Throws:

AoException

getAttributeRestValues

protected NameValueSeqUnitId getAttributeRestValues(ResultSetExt[] resultSet,
                                        int column)
                                             throws AoException

Throws:

AoException

getColumnCount

public int getColumnCount(ResultSetExt[] resultSet)
                   throws AoException

Get the column count.

Parameters:

resultSet - the result set.

Returns:

the total number of available columns.

Throws:

AoException

getRowCount

public int getRowCount(ApplicationStructure asObj,
              ResultSetExt[] resultSet,
              java.util.List<FormatToStringIF> formats)
                throws AoException

Get the row count.

Returns:

the total number of available rowsa.

Throws:

AoException

print

public void print(java.io.PrintStream out,
         ApplicationStructure asObj,
         ResultSetExt[] resultSet,
         java.util.List<java.lang.String> alias,
         java.lang.String prefix,
         java.lang.String postfix)
           throws AoException

Print out.

Specified by:

print in interface ResultSetPrinterIF

Parameters:

out - the print stream

asObj - the ASAM ODS Application Structure.

resultSet - the result set.

alias - the list that holds the aliases of the column names.

prefix - this prefix string should be printed before other output.

postfix - this postfix string should be printed at the end of the output.

Throws:

AoException

print

public void print(java.io.PrintStream out,
         ApplicationStructure asObj,
         ResultSetExt[] resultSet,
         java.util.List<java.lang.String> alias,
         java.util.List<FormatToStringIF> formats,
         java.lang.String prefix,
         java.lang.String postfix)
           throws AoException

Print out.

Specified by:

print in interface ResultSetPrinterIF

Parameters:

out - the print stream

asObj - the ASAM ODS Application Structure.

resultSet - the result set.

alias - the list that holds the aliases of the column names.

formats - the list of format strings.

prefix - this prefix string should be printed before other output.

postfix - this postfix string should be printed at the end of the output.

Throws:

AoException

print

public static void print(java.io.PrintStream out,
         ApplicationStructure asObj,
         ResultSetExt[] resultSet)
                  throws AoException

Use this static method to print your result set.

Parameters:

out - the print stream

asObj - the application structure.

resultSet - the result set.

Throws:

AoException