uk.ac.ed.epcc.webapp.jdbc.table

Class TableSpecification

java.lang.Object

uk.ac.ed.epcc.webapp.jdbc.table.TableSpecification

public class TableSpecification
extends java.lang.Object

Table Description. We use an abstract representation to make it easier to port between database back-ends. We can also store optional fields. These are not created by default but might be presented as options when editing the table structure. Normally a handler class will create this programmatically which can be used to create the underlying table if it does not exist. This can be customised by setting configuration parameters though obviously these need to be in place before the table is created. Configuration parameters are of the form create_table.table.field=specification Where the specification is one of:

• double
• float
• int
• long
• date
• boolean
• stringxxx where xxx is the string length
• required - promote an optional field
• table-tag reference to remote table

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TableSpecification.FullTextIndex
class	TableSpecification.Index
static class	TableSpecification.IndexField
class	TableSpecification.IndexType

Constructor Summary

Constructors

Constructor and Description
TableSpecification()
TableSpecification(java.lang.String key)
TableSpecification(TableSpecification spec)

Method Summary

Modifier and Type	Method and Description
FieldType	getField(java.lang.String name)
java.util.Set<java.lang.String>	getFieldNames()
java.util.Iterator<TableSpecification.IndexType>	getIndexes()
java.util.Set<java.lang.String>	getOptionalFieldNames()
java.lang.String	getPrimaryKey()
java.util.Map<java.lang.String,FieldType>	getStdFields() get a map of all fields in the specification.
boolean	goodFieldName(java.lang.String s)
boolean	hasField(java.lang.String name) Does the specification contain this name
void	promoteOptionalField(java.lang.String name) promote an optional field to required
void	setField(java.lang.String name, FieldType type)
void	setField(java.lang.String name, FieldType type, boolean optional) add a FieldType to the specification An optional field is not created by default but it does show up as an option in the table edit forms.
void	setFromParameters(AppContext conn, java.lang.String prefix, java.util.Map<java.lang.String,java.lang.String> params) add specifications from a map of parameter values
void	setOptionalField(java.lang.String name, FieldType type) add a FieldType to the specificationas an optional field An optional field is not created by default but it does show up as an option in the table edit forms.
void	setPrimaryKey(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSpecification

public TableSpecification(java.lang.String key)

TableSpecification

public TableSpecification()

TableSpecification

public TableSpecification(TableSpecification spec)

Method Detail

setPrimaryKey

public void setPrimaryKey(java.lang.String name)

getPrimaryKey

public java.lang.String getPrimaryKey()

setField

public void setField(java.lang.String name,
                     FieldType type)

hasField

public boolean hasField(java.lang.String name)

Does the specification contain this name

Parameters:

name -

Returns:

boolean

setField

public void setField(java.lang.String name,
                     FieldType type,
                     boolean optional)

add a FieldType to the specification An optional field is not created by default but it does show up as an option in the table edit forms. An optional field can be promoted to required by setting a configuration create_table.table.field=required

Parameters:

name - field name

type - FieldType

optional - boolean

See Also:

setFromParameters(AppContext, String, Map)

setOptionalField

public void setOptionalField(java.lang.String name,
                             FieldType type)

add a FieldType to the specificationas an optional field An optional field is not created by default but it does show up as an option in the table edit forms. An optional field can be promoted to required by setting a configuration create_table.table.field=required

Parameters:

name - field name

type - FieldType

See Also:

setFromParameters(AppContext, String, Map)

goodFieldName

public boolean goodFieldName(java.lang.String s)

setFromParameters

public void setFromParameters(AppContext conn,
                              java.lang.String prefix,
                              java.util.Map<java.lang.String,java.lang.String> params)

add specifications from a map of parameter values

Parameters:

prefix - key values start with this

params -

getField

public FieldType getField(java.lang.String name)

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()

getOptionalFieldNames

public java.util.Set<java.lang.String> getOptionalFieldNames()

getIndexes

public java.util.Iterator<TableSpecification.IndexType> getIndexes()

promoteOptionalField

public void promoteOptionalField(java.lang.String name)

promote an optional field to required

Parameters:

name -

getStdFields

public java.util.Map<java.lang.String,FieldType> getStdFields()

get a map of all fields in the specification.

Returns: