pl.kernelpanic.dbmonster.schema
Class Key

java.lang.Object
  pl.kernelpanic.dbmonster.schema.Key

public class Key
extends Object

The primary key.

Version:

$Id: Key.java,v 1.2 2006/01/05 16:29:37 majek Exp $

Author:

Piotr Maj <pm@jcake.com>

Constructor Summary

Key()

Method Summary

List	generate() Generates the key.
boolean	getDatabaseDefault() Returns true if this key should not be included in INSERT query allowing the database to put the default value for this column(s).
KeyGenerator	getGenerator() Returns a generator.
Table	getTable() Returns a table.
void	initialize(DBMonsterContext ctx) Initializes the key.
void	setDatabaseDefault(boolean isDatabaseDefault) Sets database default parameter
void	setGenerator(KeyGenerator gen) Sets the generator.
void	setTable(Table t) Sets the table.

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key()

Method Detail

getGenerator

public KeyGenerator getGenerator()

Returns a generator.

Returns:

generator.

setGenerator

public void setGenerator(KeyGenerator gen)

Sets the generator.

Parameters:

gen - generator

initialize

public void initialize(DBMonsterContext ctx)
                throws Exception

Initializes the key.

Parameters:

ctx - dbmonster context.

Throws:

Exception - if initialization fails

generate

public List generate()
              throws Exception

Generates the key.

Returns:

List a list of columns.

Throws:

Exception - if generation fails

setTable

public void setTable(Table t)

Sets the table.

Parameters:

t - table

getTable

public Table getTable()

Returns a table.

Returns:

a table.

getDatabaseDefault

public boolean getDatabaseDefault()

Returns true if this key should not be included in INSERT query allowing the database to put the default value for this column(s).

Returns:

defaultDatabase value

setDatabaseDefault

public void setDatabaseDefault(boolean isDatabaseDefault)

Sets database default parameter

Parameters:

isDatabaseDefault - true if DBMonster should use database default value.