planetj.dataengine
Class RowClassProperties

java.lang.Object
  |
  +--planetj.dataengine.RowClassProperties
Direct Known Subclasses:
RowInterfaceProperties

public class RowClassProperties
extends Object

Properties class for the RowClassGenerator. Use an instance of this class to set properties describing how a Row subclass should be generated.


Constructor Summary
RowClassProperties()
          RowClassProperties constructor
 
Method Summary
 String getFileLocation()
          Gets the directory name where the generated file will be saved.
 String getFullClassName()
          Gets the fully qualified name of the class to generate.
 String getLibraryName()
          This method is derrived from the getFullClassName which is return LIBRARY_NAME.TABLE_NAME for classes and LIBRARY_NAME.I + TABLE_NAME for interfaces Creation date: (4/9/2002 1:21:32 PM)
 String getPackage()
          Gets the package name of the class to generate.
 String getTableName()
          This method is derrived from the getFullClassName which is return LIBRARY_NAME.TABLE_NAME for classes and LIBRARY_NAME.I + TABLE_NAME for interfaces Creation date: (4/9/2002 1:21:32 PM)
 boolean isGenerateConstantComments()
          Insert the method's description here.
 boolean isGenerateConstantTableProperties()
          Insert the method's description here.
 boolean isGenerateFieldNameConstants()
          Tests if constants should be generated for field names.
 boolean isGenerateGetters()
          Tests if getter methods should be generated.
 boolean isGeneratePackage()
          Insert the method's description here.
 boolean isGenerateSetters()
          Tests if setter methods should be generated.
 boolean isUsePrimitives()
          Tests if primitives should be used instead of Java objects.
 RowClassProperties setFileLocation(String newFileLocation)
          Sets the directory name where the generated file will be saved.
 RowClassProperties setFullClassName(String newFullClassName)
          Sets the fully qualified name of the class to generate.
 void setGenerateConstantComments(boolean newGenerateConstantComments)
          Insert the method's description here.
 void setGenerateConstantTableProperties(boolean newGenerateConstantTableProperties)
          Insert the method's description here.
 RowClassProperties setGenerateFieldNameConstants(boolean newGenerateFieldNameConstants)
          Sets if constants should be generated for field names.
 RowClassProperties setGenerateGetters(boolean newGenerateGetters)
          Sets if getter methods should be generated.
 void setGeneratePackage(boolean newGeneratePackage)
          Insert the method's description here.
 RowClassProperties setGenerateSetters(boolean newGenerateSetters)
          Sets if setter methods should be generated.
 RowClassProperties setPackage(String newPackage)
          Sets the package name of the class to generate.
 RowClassProperties setUsePrimitives(boolean newUsePrimitives)
          Sets if primitives should be used instead of Java objects.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RowClassProperties

public RowClassProperties()
RowClassProperties constructor

Method Detail

getFileLocation

public String getFileLocation()
Gets the directory name where the generated file will be saved.


getFullClassName

public String getFullClassName()
Gets the fully qualified name of the class to generate. This property is required.


getPackage

public String getPackage()
Gets the package name of the class to generate.


getLibraryName

public String getLibraryName()
This method is derrived from the getFullClassName which is return LIBRARY_NAME.TABLE_NAME for classes and LIBRARY_NAME.I + TABLE_NAME for interfaces Creation date: (4/9/2002 1:21:32 PM)


getTableName

public String getTableName()
This method is derrived from the getFullClassName which is return LIBRARY_NAME.TABLE_NAME for classes and LIBRARY_NAME.I + TABLE_NAME for interfaces Creation date: (4/9/2002 1:21:32 PM)


isGenerateConstantComments

public boolean isGenerateConstantComments()
Insert the method's description here. Creation date: (4/8/2002 5:11:57 PM)

Returns:
boolean

isGeneratePackage

public boolean isGeneratePackage()
Insert the method's description here. Creation date: (4/8/2002 5:11:57 PM)

Returns:
boolean

isGenerateConstantTableProperties

public boolean isGenerateConstantTableProperties()
Insert the method's description here. Creation date: (4/9/2002 1:27:00 PM)

Returns:
boolean

isGenerateFieldNameConstants

public boolean isGenerateFieldNameConstants()
Tests if constants should be generated for field names. If the SQL name for the Format Name column is FMTNME the generated constant would be

public static final String FORMAT_NAME = "FMTNME";


isGenerateGetters

public boolean isGenerateGetters()
Tests if getter methods should be generated.


isGenerateSetters

public boolean isGenerateSetters()
Tests if setter methods should be generated.


isUsePrimitives

public boolean isUsePrimitives()
Tests if primitives should be used instead of Java objects. If this is true, then the getters and setters for all fields which store Integer objects (for example) will take and return int's instead of Integer objects.


setFileLocation

public RowClassProperties setFileLocation(String newFileLocation)
Sets the directory name where the generated file will be saved.


setFullClassName

public RowClassProperties setFullClassName(String newFullClassName)
Sets the fully qualified name of the class to generate. This property is required.


setPackage

public RowClassProperties setPackage(String newPackage)
Sets the package name of the class to generate.


setGenerateConstantComments

public void setGenerateConstantComments(boolean newGenerateConstantComments)
Insert the method's description here. Creation date: (4/8/2002 5:11:57 PM)

Parameters:
newGenerateConstantComments - boolean

setGenerateConstantTableProperties

public void setGenerateConstantTableProperties(boolean newGenerateConstantTableProperties)
Insert the method's description here. Creation date: (4/9/2002 1:27:00 PM)

Parameters:
newGenerateConstantTableProperties - boolean

setGeneratePackage

public void setGeneratePackage(boolean newGeneratePackage)
Insert the method's description here. Creation date: (4/9/2002 1:27:00 PM)


setGenerateFieldNameConstants

public RowClassProperties setGenerateFieldNameConstants(boolean newGenerateFieldNameConstants)
Sets if constants should be generated for field names. If the SQL name for the Format Name column is FMTNME the generated constant would be

public static final String FORMAT_NAME = "FMTNME";


setGenerateGetters

public RowClassProperties setGenerateGetters(boolean newGenerateGetters)
Sets if getter methods should be generated.


setGenerateSetters

public RowClassProperties setGenerateSetters(boolean newGenerateSetters)
Sets if setter methods should be generated.


setUsePrimitives

public RowClassProperties setUsePrimitives(boolean newUsePrimitives)
Sets if primitives should be used instead of Java objects. If this is true, then the getters and setters for all fields which store Integer objects (for example) will take and return int's instead of Integer objects.