org.gcube.portlets.user.tdw.shared.model

Class TableDefinition

java.lang.Object

org.gcube.portlets.user.tdw.shared.model.TableDefinition

All Implemented Interfaces:

Serializable

public class TableDefinition
extends Object
implements Serializable

Describes a table in the widget model.

Author:

"Federico De Faveri defaveri@isti.cnr.it"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ColumnDefinition>	columns
static String	DEFAULT_JSON_OFFSET_FIELD
static String	DEFAULT_JSON_ROWS_FIELD
static String	DEFAULT_JSON_TOTAL_LENGTH_FIELD
protected TableId	id
protected String	jsonOffsetField
protected String	jsonRowsField
protected String	jsonTotalLengthField
protected List<ColumnKey>	keys
protected int	keySeed
protected String	modelKeyColumnId
protected String	name

Constructor Summary

Constructors

Constructor and Description
TableDefinition()
TableDefinition(TableId id, String name) Creates a new Table definition.
TableDefinition(TableId id, String name, String jsonRowsField, String jsonTotalLengthField, String jsonOffsetField) Creates a new Table definition.
TableDefinition(TableId id, String name, String jsonRowsField, String jsonTotalLengthField, String jsonOffsetField, List<ColumnDefinition> columns) Creates a new Table definition.
TableDefinition(TableId id, String name, String jsonRowsField, String jsonTotalLengthField, String jsonOffsetField, Map<String,ColumnDefinition> columns) Creates a new Table definition.

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnDefinition column) Adds a new column definition.
Map<String,ColumnDefinition>	getColumns() Returns the column definitions.
List<ColumnDefinition>	getColumnsAsList()
TableId	getId()
String	getJsonOffsetField()
String	getJsonRowsField()
String	getJsonTotalLengthField()
List<ColumnKey>	getKeys() Returns the columns keys.
ColumnDefinition	getModelKeyColumn()
String	getName()
void	setJsonOffsetField(String jsonOffsetField)
void	setJsonRowsField(String jsonRowsField)
void	setJsonTotalLengthField(String jsonTotalLengthField)
void	setModelKeyColumnId(String modelKeyColumnId) Sets the model key column.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JSON_ROWS_FIELD

public static final String DEFAULT_JSON_ROWS_FIELD

See Also:

Constant Field Values

DEFAULT_JSON_TOTAL_LENGTH_FIELD

public static final String DEFAULT_JSON_TOTAL_LENGTH_FIELD

See Also:

Constant Field Values

DEFAULT_JSON_OFFSET_FIELD

public static final String DEFAULT_JSON_OFFSET_FIELD

See Also:

Constant Field Values

id

protected TableId id

name

protected String name

jsonRowsField

protected String jsonRowsField

jsonTotalLengthField

protected String jsonTotalLengthField

jsonOffsetField

protected String jsonOffsetField

modelKeyColumnId

protected String modelKeyColumnId

columns

protected Map<String,ColumnDefinition> columns

keys

protected List<ColumnKey> keys

keySeed

protected int keySeed

Constructor Detail

TableDefinition

public TableDefinition()

TableDefinition

public TableDefinition(TableId id,
                       String name)

Creates a new Table definition.

Parameters:

id - the table id.

name - the table name.

TableDefinition

public TableDefinition(TableId id,
                       String name,
                       String jsonRowsField,
                       String jsonTotalLengthField,
                       String jsonOffsetField)

Creates a new Table definition.

Parameters:

id - the table id.

name - the table name.

jsonRowsField - the rows field in the JSON data object.

jsonTotalLengthField - the total length field in the JSON data object.

jsonOffsetField - the offset field in the JSON data object.

TableDefinition

public TableDefinition(TableId id,
                       String name,
                       String jsonRowsField,
                       String jsonTotalLengthField,
                       String jsonOffsetField,
                       Map<String,ColumnDefinition> columns)

Creates a new Table definition.

Parameters:

id - the table id.

name - the table name.

jsonRowsField - the rows field in the JSON data object.

jsonTotalLengthField - the total length field in the JSON object.

jsonOffsetField - the offset field in the JSON object.

columns - the column definitions as column id - column definition map.

TableDefinition

public TableDefinition(TableId id,
                       String name,
                       String jsonRowsField,
                       String jsonTotalLengthField,
                       String jsonOffsetField,
                       List<ColumnDefinition> columns)

Creates a new Table definition.

Parameters:

id - the table id.

name - the table name.

jsonRowsField - the rows field in the JSON data object.

jsonTotalLengthField - the total length field in the JSON object.

jsonOffsetField - the offset field in the JSON object.

columns - the column definitions as column definition list.

Method Detail

getId

public TableId getId()

Returns:

the table id.

getName

public String getName()

Returns:

the table name.

getJsonRowsField

public String getJsonRowsField()

Returns:

the JSON object rows field name.

setJsonRowsField

public void setJsonRowsField(String jsonRowsField)

Parameters:

jsonRowsField - the jsonRowsField to set

getJsonTotalLengthField

public String getJsonTotalLengthField()

Returns:

the JSON object length field name.

setJsonTotalLengthField

public void setJsonTotalLengthField(String jsonTotalLengthField)

Parameters:

jsonTotalLengthField - the jsonTotalLengthField to set

getJsonOffsetField

public String getJsonOffsetField()

Returns:

the JSON object offset field name.

setJsonOffsetField

public void setJsonOffsetField(String jsonOffsetField)

Parameters:

jsonOffsetField - the jsonOffsetField to set

getModelKeyColumn

public ColumnDefinition getModelKeyColumn()

Returns:

the model Key column.

setModelKeyColumnId

public void setModelKeyColumnId(String modelKeyColumnId)

Sets the model key column.

Parameters:

modelKeyColumn - the modelKeyColumn to set

getColumns

public Map<String,ColumnDefinition> getColumns()

Returns the column definitions.

Returns:

the column definitions

getColumnsAsList

public List<ColumnDefinition> getColumnsAsList()

addColumn

public void addColumn(ColumnDefinition column)

Adds a new column definition.

Parameters:

column - the column definition.

getKeys

public List<ColumnKey> getKeys()

Returns the columns keys.

Returns:

the columns keys.

toString

public String toString()

Overrides:

toString in class Object