Column (sql2java-maven-plugin 0.9.0 API)

java.lang.Object
- net.sourceforge.sql2java.Column

All Implemented Interfaces:: Cloneable

public class Column
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`M_ARRAY`
`static int`	`M_BIGDECIMAL`
`static int`	`M_BLOB`
`static int`	`M_BOOLEAN`
`static int`	`M_BYTES`
`static int`	`M_CLOB`
`static int`	`M_DOUBLE`
`static int`	`M_FLOAT`
`static int`	`M_INTEGER`
`static int`	`M_LONG`
`static int`	`M_OBJECT`
`static int`	`M_REF`
`static int`	`M_SQLDATE`
`static int`	`M_STRING`
`static int`	`M_TIME`
`static int`	`M_TIMESTAMP`
`static int`	`M_URL`
`static int`	`M_UTILDATE`

Constructor Summary

Constructors
Constructor and Description

Column()

Constructors
Constructor and Description
`Column()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addForeignKey(Column col)`
`void`	`addImportedKey(Column col)`
`Object`	`clone()`
`boolean`	`columnFor(String type)` is this column described to be in the given type ? check in sql2java.properties the table.[TABLENAME].in.[TYPE].exclude & table.[TABLENAME].in.[TYPE].include
`int`	`countForeignKeys()`
`int`	`countImportedKeys()`
`String`	`getCatalog()`
`String`	`getCheckingType()`
`String`	`getConstName()`
`int`	`getDecimalDigits()`
`String`	`getDefaultRules()`
`String`	`getDefaultValue()`
`String`	`getDefaultWidget()`
`Column`	`getForeignColumn()`
`List`	`getForeignKeys()`
`String`	`getFullName()`
`List`	`getImportedKeys()`
`String`	`getJavaPrimaryType()` return the primary java type of the current column return null if no java primary type is available
`String`	`getJavaType()` return the java type of the current column
`String`	`getJavaTypeAsTypeName()` return the string representation of the column type
`int`	`getMappedType()` return internal type for the current column
`String`	`getName()`
`int`	`getNullable()`
`String`	`getNullableAsString()`
`int`	`getOrdinalPosition()`
`String`	`getPreparedStatementMethod(String var, int pos)` Maps the SQL type for the column to a "set" method to call on the PreparedStatement.
`String`	`getPreparedStatementMethod(String var, String pos)`
`String`	`getPropertyTag()`
`int`	`getRadix()`
`String`	`getRemarks()`
`String`	`getResultSetMethodObject(String pos)` return the resultSet get method for a given position the assumption is that the resultset variable is called rs
`String`	`getResultSetMethodObject(String resultSet, String pos)`
`String`	`getSchema()`
`int`	`getSize()`
`String`	`getStringConvertionMethod()` method to convert the given string into the internal java representation
`Table`	`getTable()`
`String`	`getTableName()`
`short`	`getType()`
`String`	`getVarName()`
`boolean`	`hasCompareTo()` does this type has a compareTo method ?
`boolean`	`hasPrimaryType()` does this column has a primary java type like short, boolean instead of Integer and Boolean ?
`boolean`	`isColumnNumeric()` is this column numeric ?
`boolean`	`isForeignKey()`
`boolean`	`isImportedKey()`
`boolean`	`isPrimaryKey()`
`void`	`isPrimaryKey(boolean isPrimaryKey)`
`boolean`	`isString()` is this column a string ?
`void`	`setCatalog(String catalog)`
`void`	`setCheckingType(String strValue)`
`void`	`setDatabase(Database db)`
`void`	`setDecimalDigits(int decDigits)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setName(String name)`
`void`	`setNullable(int nullable)`
`void`	`setOrdinalPosition(int ordinal)`
`void`	`setRadix(int radix)`
`void`	`setRemarks(String remarks)`
`void`	`setSchema(String schema)`
`void`	`setSize(int size)`
`void`	`setTableName(String tableName)`
`void`	`setType(short type)`
`String`	`toString()`
`boolean`	`useEqualsInSetter()` does this type can use equal instead of the compareTo method ?

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- M_ARRAY
```
public static final int M_ARRAY
```
  See Also:
  Constant Field Values
- M_BIGDECIMAL
```
public static final int M_BIGDECIMAL
```
  See Also:
  Constant Field Values
- M_BOOLEAN
```
public static final int M_BOOLEAN
```
  See Also:
  Constant Field Values
- M_BYTES
```
public static final int M_BYTES
```
  See Also:
  Constant Field Values
- M_CLOB
```
public static final int M_CLOB
```
  See Also:
  Constant Field Values
- M_SQLDATE
```
public static final int M_SQLDATE
```
  See Also:
  Constant Field Values
- M_UTILDATE
```
public static final int M_UTILDATE
```
  See Also:
  Constant Field Values
- M_DOUBLE
```
public static final int M_DOUBLE
```
  See Also:
  Constant Field Values
- M_FLOAT
```
public static final int M_FLOAT
```
  See Also:
  Constant Field Values
- M_BLOB
```
public static final int M_BLOB
```
  See Also:
  Constant Field Values
- M_INTEGER
```
public static final int M_INTEGER
```
  See Also:
  Constant Field Values
- M_LONG
```
public static final int M_LONG
```
  See Also:
  Constant Field Values
- M_REF
```
public static final int M_REF
```
  See Also:
  Constant Field Values
- M_STRING
```
public static final int M_STRING
```
  See Also:
  Constant Field Values
- M_TIME
```
public static final int M_TIME
```
  See Also:
  Constant Field Values
- M_TIMESTAMP
```
public static final int M_TIMESTAMP
```
  See Also:
  Constant Field Values
- M_URL
```
public static final int M_URL
```
  See Also:
  Constant Field Values
- M_OBJECT
```
public static final int M_OBJECT
```
  See Also:
  Constant Field Values

Constructor Detail
- Column
```
public Column()
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

setCheckingType

public void setCheckingType(String strValue)

getCheckingType
```
public String getCheckingType()
```

setDatabase
```
public void setDatabase(Database db)
```

setCatalog

public void setCatalog(String catalog)

setSchema
```
public void setSchema(String schema)
```

setTableName

public void setTableName(String tableName)

setName
```
public void setName(String name)
```

setType
```
public void setType(short type)
```

setSize
```
public void setSize(int size)
```

setDecimalDigits

public void setDecimalDigits(int decDigits)

setRadix
```
public void setRadix(int radix)
```

setNullable

public void setNullable(int nullable)

setRemarks

public void setRemarks(String remarks)

setDefaultValue

public void setDefaultValue(String defaultValue)

setOrdinalPosition

public void setOrdinalPosition(int ordinal)

isPrimaryKey

public void isPrimaryKey(boolean isPrimaryKey)

getCatalog
```
public String getCatalog()
```

getSchema
```
public String getSchema()
```

getTableName
```
public String getTableName()
```

getName
```
public String getName()
```

getType
```
public short getType()
```

getSize
```
public int getSize()
```

getDecimalDigits
```
public int getDecimalDigits()
```

getRadix
```
public int getRadix()
```

getNullable
```
public int getNullable()
```

getNullableAsString
```
public String getNullableAsString()
```

getRemarks
```
public String getRemarks()
```

getDefaultValue
```
public String getDefaultValue()
```

getOrdinalPosition
```
public int getOrdinalPosition()
```

isPrimaryKey
```
public boolean isPrimaryKey()
```

getFullName
```
public String getFullName()
```

getConstName
```
public String getConstName()
```

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:: clone in class Object
Throws:: CloneNotSupportedException

getMappedType
```
public int getMappedType()
```
return internal type for the current column

getJavaType
```
public String getJavaType()
```
return the java type of the current column

hasPrimaryType
```
public boolean hasPrimaryType()
```
does this column has a primary java type like short, boolean instead of Integer and Boolean ?

getJavaPrimaryType
```
public String getJavaPrimaryType()
                          throws IllegalArgumentException
```
return the primary java type of the current column return null if no java primary type is available

Throws:

IllegalArgumentException

getJavaTypeAsTypeName
```
public String getJavaTypeAsTypeName()
```
return the string representation of the column type

isColumnNumeric
```
public boolean isColumnNumeric()
```
is this column numeric ?

isString
```
public boolean isString()
```
is this column a string ?

hasCompareTo

public boolean hasCompareTo()
                     throws Exception

does this type has a compareTo method ?

Throws:: Exception

useEqualsInSetter
```
public boolean useEqualsInSetter()
                          throws Exception
```
does this type can use equal instead of the compareTo method ?

Throws:

Exception

getResultSetMethodObject
```
public String getResultSetMethodObject(String pos)
```
return the resultSet get method for a given position the assumption is that the resultset variable is called rs

getResultSetMethodObject

public String getResultSetMethodObject(String resultSet,
                              String pos)

getPreparedStatementMethod
```
public String getPreparedStatementMethod(String var,
                                int pos)
```
Maps the SQL type for the column to a "set" method to call on the PreparedStatement.
This is used when generating Manager classes. There are some variations in how different databases may deal with this, so you might look at the OracleManagerWriter to see how you might have to override this method for your particular database.

Parameters:
var - Java code that represents how we'll get access to the value to set. You should be able to use this value verbatim. Check out the source to this method to see what we mean.
pos - The position to pass as the first argument of the set method. You will be able to use this verbatim too.

Returns:
The string to write into the generated Manager .java file.

getPreparedStatementMethod

public String getPreparedStatementMethod(String var,
                                String pos)

getStringConvertionMethod
```
public String getStringConvertionMethod()
```
method to convert the given string into the internal java representation

getDefaultWidget
```
public String getDefaultWidget()
```

getTable
```
public Table getTable()
```

addForeignKey

public void addForeignKey(Column col)

getForeignKeys
```
public List getForeignKeys()
```

addImportedKey

public void addImportedKey(Column col)

getImportedKeys
```
public List getImportedKeys()
```

countImportedKeys
```
public int countImportedKeys()
```

isImportedKey
```
public boolean isImportedKey()
```

getForeignColumn
```
public Column getForeignColumn()
```

countForeignKeys
```
public int countForeignKeys()
```

isForeignKey
```
public boolean isForeignKey()
```

getPropertyTag
```
public String getPropertyTag()
```

getVarName
```
public String getVarName()
```

getDefaultRules
```
public String getDefaultRules()
```

columnFor
```
public boolean columnFor(String type)
```
is this column described to be in the given type ? check in sql2java.properties the table.[TABLENAME].in.[TYPE].exclude & table.[TABLENAME].in.[TYPE].include

Class Column

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

M_ARRAY

M_BIGDECIMAL

M_BOOLEAN

M_BYTES

M_CLOB

M_SQLDATE

M_UTILDATE

M_DOUBLE

M_FLOAT

M_BLOB

M_INTEGER

M_LONG

M_REF

M_STRING

M_TIME

M_TIMESTAMP

M_URL

M_OBJECT

Constructor Detail

Column

Method Detail

toString

setCheckingType

getCheckingType

setDatabase

setCatalog

setSchema

setTableName

setName

setType

setSize

setDecimalDigits

setRadix

setNullable

setRemarks

setDefaultValue

setOrdinalPosition

isPrimaryKey

getCatalog

getSchema

getTableName

getName

getType

getSize

getDecimalDigits

getRadix

getNullable

getNullableAsString

getRemarks

getDefaultValue

getOrdinalPosition

isPrimaryKey

getFullName

getConstName

clone

getMappedType

getJavaType

hasPrimaryType

getJavaPrimaryType

getJavaTypeAsTypeName

isColumnNumeric

isString

hasCompareTo

useEqualsInSetter

getResultSetMethodObject

getResultSetMethodObject

getPreparedStatementMethod

getPreparedStatementMethod

getStringConvertionMethod

getDefaultWidget

getTable

addForeignKey

getForeignKeys

addImportedKey