CodeWriter (sql2java-maven-plugin 0.9.0 API)

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

```
public class CodeWriter
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`basePackage`
`String`	`classPrefix`
`protected org.apache.velocity.VelocityContext`	`current_vc`
`protected static String`	`dateClassName`
`protected Database`	`db`
`protected String`	`destDir`
`protected Hashtable`	`excludeHash`
`protected Hashtable`	`includeHash`
`protected String`	`libraryPackage`
`protected String`	`optimisticLockColumn`
`protected String`	`optimisticLockType`
`protected static Properties`	`props`
`Table`	`table`
`protected static String`	`timeClassName`
`protected static String`	`timestampClassName`
`protected boolean`	`useLibrary`
`protected org.apache.velocity.VelocityContext`	`vc`

Constructor Summary

Constructors
Constructor and Description

CodeWriter(Database db, Properties props)
The Default Constructor

Constructors
Constructor and Description
`CodeWriter(Database db, Properties props)` The Default Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkDatabase()`
`boolean`	`checkTable(Table table)`
`void`	`cleanup()`
`String`	`getClassPrefix()`
`List`	`getColumns()` Return table.getColumns() as a List
`Database`	`getDb()` Public accessor for db
`List`	`getForeignKeys()` Return table.getForeignKeys() as a List
`List`	`getImportedKeys()` Return table.getImportedKeys() as a List
`List`	`getLinkedTables(Table rTable)` Returns a table's linked tables as a list
`Column`	`getLockColumn(Collection cols)` Find the column in the Collection that matches optimisticLockColumn
`List`	`getPrimaryKeys()` Return table.getPrimaryKeys() as a List
`static String`	`getProperty(String key)` Convenience property chop method
`static String`	`getProperty(String key, String default_val)` Convenience property chop method
`static String[]`	`getPropertyExploded(String key)` Return as a String array the key's value.
`List`	`getRelationTable()` Returns a db.getRelationTable( table ) as a list
`String`	`getRemarks()` Returns the current table's remarks.
`Table`	`getTable()` public accessor for table
`Table`	`getTable(String tableName)` Public db.getTables()
`List`	`getTables()` Public db.getTables()
`boolean`	`hasRemarks()` Returns true if the current table.getRemarks().length() > 0
`boolean`	`isPresentLock(Collection cols)` Wrapper for the static Column method
`boolean`	`listContainsString(List list, String string)` Check if a list contains an item that is equal() to a string
`void`	`log(String logStr)` System.out.println() wrapper
`void`	`process()` The entry point for generating code.
`void`	`setCurrentFilename(String relpath_or_package, String fn)`
`void`	`setCurrentJavaFilename(String relpath_or_package, String fn)`
`void`	`setDestinationFolder(String destDir)`
`void`	`setUseLibrary(String libraryPackage)`
`String`	`tableName()` Return table.getName()
`void`	`writeComponent(String templateName)` This method creates a file and generates the class; it is based on the original SQL2Java methods The filename for the class is based on the value of the Velocity variable passed in.

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

Field Detail

props
```
protected static Properties props
```

dateClassName
```
protected static String dateClassName
```

timeClassName
```
protected static String timeClassName
```

timestampClassName

protected static String timestampClassName

db
```
protected Database db
```

includeHash
```
protected Hashtable includeHash
```

excludeHash
```
protected Hashtable excludeHash
```

basePackage
```
protected String basePackage
```

destDir
```
protected String destDir
```

optimisticLockType
```
protected String optimisticLockType
```

optimisticLockColumn
```
protected String optimisticLockColumn
```

classPrefix
```
public String classPrefix
```

vc

protected org.apache.velocity.VelocityContext vc

table
```
public Table table
```

current_vc

protected org.apache.velocity.VelocityContext current_vc

useLibrary
```
protected boolean useLibrary
```

libraryPackage
```
protected String libraryPackage
```

Constructor Detail
- CodeWriter
```
public CodeWriter(Database db,
          Properties props)
```
  The Default Constructor
  
  Parameters:
  props - Properties for configuring this instance

Method Detail
- setUseLibrary
```
public void setUseLibrary(String libraryPackage)
```
- setDestinationFolder
```
public void setDestinationFolder(String destDir)
                          throws Exception
```
  Throws:
  
  Exception
- checkTable
```
public boolean checkTable(Table table)
                   throws Exception
```
  Throws:
  
  Exception
- checkDatabase
```
public void checkDatabase()
                   throws Exception
```
  Throws:
  
  Exception
- cleanup
```
public void cleanup()
```
- process
```
public void process()
             throws Exception
```
  The entry point for generating code.
  
  Throws:
  
  Exception
- writeComponent
```
public void writeComponent(String templateName)
                    throws Exception
```
  This method creates a file and generates the class; it is based on the original SQL2Java methods The filename for the class is based on the value of the Velocity variable passed in.
  
  Parameters:
  templateName - The template to parse and generate from
  variableFileName - A velocity variable on which to base the filename
  
  Throws:
  
  Exception - (IOExceptions?)
- setCurrentFilename
```
public void setCurrentFilename(String relpath_or_package,
                      String fn)
                        throws Exception
```
  Throws:
  
  Exception
- setCurrentJavaFilename
```
public void setCurrentJavaFilename(String relpath_or_package,
                          String fn)
                            throws Exception
```
  Throws:
  
  Exception
- log
```
public void log(String logStr)
```
  System.out.println() wrapper
- getClassPrefix
```
public String getClassPrefix()
```
- getDb
```
public Database getDb()
```
  Public accessor for db
- getTables
```
public List getTables()
```
  Public db.getTables()
- getTable
```
public Table getTable(String tableName)
```
  Public db.getTables()
- tableName
```
public String tableName()
```
  Return table.getName()
- getColumns
```
public List getColumns()
```
  Return table.getColumns() as a List
- getImportedKeys
```
public List getImportedKeys()
```
  Return table.getImportedKeys() as a List
- getForeignKeys
```
public List getForeignKeys()
```
  Return table.getForeignKeys() as a List
- getPrimaryKeys
```
public List getPrimaryKeys()
```
  Return table.getPrimaryKeys() as a List
- hasRemarks
```
public boolean hasRemarks()
```
  Returns true if the current table.getRemarks().length() > 0
- getRemarks
```
public String getRemarks()
```
  Returns the current table's remarks.
- getRelationTable
```
public List getRelationTable()
```
  Returns a db.getRelationTable( table ) as a list
- getLinkedTables
```
public List getLinkedTables(Table rTable)
```
  Returns a table's linked tables as a list
- isPresentLock
```
public boolean isPresentLock(Collection cols)
```
  Wrapper for the static Column method
- getLockColumn
```
public Column getLockColumn(Collection cols)
```
  Find the column in the Collection that matches optimisticLockColumn
- getTable
```
public Table getTable()
```
  public accessor for table
- listContainsString
```
public boolean listContainsString(List list,
                         String string)
```
  Check if a list contains an item that is equal() to a string
- getProperty
```
public static String getProperty(String key)
```
  Convenience property chop method
  
  Parameters:
  key - the property to get from this.props
  
  Returns:
  the associated value
- getProperty
```
public static String getProperty(String key,
                 String default_val)
```
  Convenience property chop method
  
  Parameters:
  key - the property to get from this.props
  default_val - the default value to return in case not found
  
  Returns:
  the associated value
- getPropertyExploded
```
public static String[] getPropertyExploded(String key)
```
  Return as a String array the key's value.

Class CodeWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

props

dateClassName

timeClassName

timestampClassName

db

includeHash

excludeHash

basePackage

destDir

optimisticLockType

optimisticLockColumn

classPrefix

vc

table

current_vc

useLibrary

libraryPackage

Constructor Detail

CodeWriter

Method Detail

setUseLibrary

setDestinationFolder

checkTable

checkDatabase

cleanup

process

writeComponent

setCurrentFilename

setCurrentJavaFilename

log

getClassPrefix

getDb

getTables

getTable

tableName

getColumns

getImportedKeys

getForeignKeys

getPrimaryKeys

hasRemarks

getRemarks

getRelationTable

getLinkedTables

isPresentLock

getLockColumn

getTable

listContainsString

getProperty

getProperty

getPropertyExploded