com.tekann.codegen.pda.db
Class DefaultDTO

java.lang.Object
  extended by com.tekann.codegen.pda.db.DefaultDTO
All Implemented Interfaces:
IDTO

public class DefaultDTO
extends java.lang.Object
implements IDTO

Class that represents a row in a table DAO.
This class has some useful methods to work on it such as retrieving the columns information like the data type, if the column is a primary key and much more.

Author:
Evandro Rathke

Constructor Summary
DefaultDTO()
          Constructs a new DefaultDTO
DefaultDTO(int columnsCount)
          Constructor with columns number.
DefaultDTO(java.lang.String tableName)
          Constructor with a table name.
 
Method Summary
 IDTOColumn addColumn(java.lang.String columnName)
          Adds a column to the DTO
 IDTOColumn addColumn(java.lang.String columnName, int type)
          Adds a column setting its type.
 IDTOColumn addColumn(java.lang.String columnName, int type, java.lang.String dbType)
          Adds a column setting its type and DB type.
 byte[] getBytes()
          Get DTO xml format in byte array.
 IDTOColumn getColumn(java.lang.String columnName)
          Get DTO object column by name.
 java.lang.Object[] getColumns()
          Get DTO object columns.
 java.lang.String getDbType(java.lang.String columnName)
          Get DTO type.
 int getRowStatus()
          Gets the row status.
 java.lang.String getTableName()
          Get DTO table's name;
 int getType(java.lang.String columnName)
          Get DTO type.
 java.lang.Object getValue(java.lang.String columnName)
          Get DTO value.
 boolean isLiteral(java.lang.String columnName)
          Gets if the column is literal or not.
 boolean isPK(java.lang.String columnName)
          Gets the boolean value for the column.
 void setDbType(java.lang.String columnName, java.lang.String dbType)
          Set DTO type.
 void setLiteral(java.lang.String columnName, boolean literal)
          Sets the column as literal
 void setPK(java.lang.String columnName, boolean value)
          Sets if the column will be PK.
 void setRowStatus(int status)
          Sets the row status.
 void setSQLType(java.lang.String columnName, int sqlType)
          Sets the sql type
 void setTableName(java.lang.String tableName)
          Sets the table name.
 void setType(java.lang.String columnName, int type)
          Set DTO type.
 void setValue(java.lang.String columnName, java.lang.Object value)
          Set DTO value.
 java.lang.Object[] toArray()
          Returns the values in an array.
 java.lang.String toXML()
          Get DTO XML format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultDTO

public DefaultDTO()
Constructs a new DefaultDTO


DefaultDTO

public DefaultDTO(int columnsCount)
Constructor with columns number.

Parameters:
columnsCount -

DefaultDTO

public DefaultDTO(java.lang.String tableName)
Constructor with a table name.

Parameters:
tableName -
Method Detail

addColumn

public IDTOColumn addColumn(java.lang.String columnName)
Adds a column to the DTO

Parameters:
columnName -
Returns:
An IDTOColumn for the passed columnName

addColumn

public IDTOColumn addColumn(java.lang.String columnName,
                            int type)
Adds a column setting its type.

Parameters:
columnName -
type -
Returns:
An IDTOColumn for the passed columnName

addColumn

public IDTOColumn addColumn(java.lang.String columnName,
                            int type,
                            java.lang.String dbType)
Adds a column setting its type and DB type.

Parameters:
columnName -
type -
dbType -
Returns:
An IDTOColumn

getBytes

public byte[] getBytes()
Description copied from interface: IDTO
Get DTO xml format in byte array.

Specified by:
getBytes in interface IDTO
Returns:
A byte array

getColumn

public IDTOColumn getColumn(java.lang.String columnName)
Description copied from interface: IDTO
Get DTO object column by name.

Specified by:
getColumn in interface IDTO
Returns:
An IDTOColumn

getColumns

public java.lang.Object[] getColumns()
Description copied from interface: IDTO
Get DTO object columns.

Specified by:
getColumns in interface IDTO
Returns:
A Object array

getDbType

public java.lang.String getDbType(java.lang.String columnName)
Description copied from interface: IDTO
Get DTO type.

Specified by:
getDbType in interface IDTO
Returns:
A String

getRowStatus

public int getRowStatus()
Description copied from interface: IDTO
Gets the row status.

Specified by:
getRowStatus in interface IDTO
Returns:
An int

getTableName

public java.lang.String getTableName()
Description copied from interface: IDTO
Get DTO table's name;

Specified by:
getTableName in interface IDTO
Returns:
A String

getType

public int getType(java.lang.String columnName)
Description copied from interface: IDTO
Get DTO type.

Specified by:
getType in interface IDTO
Returns:
A String

getValue

public java.lang.Object getValue(java.lang.String columnName)
Description copied from interface: IDTO
Get DTO value.

Specified by:
getValue in interface IDTO
Returns:
A Object

isLiteral

public boolean isLiteral(java.lang.String columnName)
Description copied from interface: IDTO
Gets if the column is literal or not.

Specified by:
isLiteral in interface IDTO
Returns:
A boolean

isPK

public boolean isPK(java.lang.String columnName)
Description copied from interface: IDTO
Gets the boolean value for the column.

Specified by:
isPK in interface IDTO
Returns:
A boolean

setDbType

public void setDbType(java.lang.String columnName,
                      java.lang.String dbType)
Description copied from interface: IDTO
Set DTO type.

Specified by:
setDbType in interface IDTO

setLiteral

public void setLiteral(java.lang.String columnName,
                       boolean literal)
Sets the column as literal

Parameters:
columnName -
literal -

setPK

public void setPK(java.lang.String columnName,
                  boolean value)
Description copied from interface: IDTO
Sets if the column will be PK.

Specified by:
setPK in interface IDTO

setRowStatus

public void setRowStatus(int status)
Description copied from interface: IDTO
Sets the row status. The status value can be: RowIteratorValues. ROW_ATTR_DELETED ROW_ATTR_NEW ROW_ATTR_SYNCED ROW_ATTR_UPDATED

Specified by:
setRowStatus in interface IDTO

setSQLType

public void setSQLType(java.lang.String columnName,
                       int sqlType)
Sets the sql type

Parameters:
columnName -
sqlType -

setTableName

public void setTableName(java.lang.String tableName)
Sets the table name.

Parameters:
tableName -

setType

public void setType(java.lang.String columnName,
                    int type)
Description copied from interface: IDTO
Set DTO type.

Specified by:
setType in interface IDTO

setValue

public void setValue(java.lang.String columnName,
                     java.lang.Object value)
Description copied from interface: IDTO
Set DTO value.

Specified by:
setValue in interface IDTO

toArray

public java.lang.Object[] toArray()
Description copied from interface: IDTO
Returns the values in an array.

Specified by:
toArray in interface IDTO
Returns:
An Object array

toXML

public java.lang.String toXML()
Description copied from interface: IDTO
Get DTO XML format.

Specified by:
toXML in interface IDTO
Returns:
A String