org.openlowcode.server.data.storage

Class StoredTableIndex

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.data.storage.StoredTableIndex

All Implemented Interfaces:

NamedInterface

public class StoredTableIndex
extends Named

An index on the table

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
StoredTableIndex(java.lang.String name) creates an index with a name (but not field specified yet)

Method Summary

Modifier and Type	Method and Description
void	addStoredFieldSchame(StoredFieldSchema indexfield) adds a new stored field in the index
StoredFieldSchema[]	getAllFields() get all fields of the index
StoredFieldSchema	getField(int i) gets a field in the index
int	getFieldNumber() get the number of fields in this index
java.lang.String	getFullName() generates the name in the database
StoredTableSchema	getParent() gets the parent table schema
void	setParent(StoredTableSchema parent)

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredTableIndex

public StoredTableIndex(java.lang.String name)

creates an index with a name (but not field specified yet)

Parameters:

name - name of the index

Method Detail

getParent

public StoredTableSchema getParent()

gets the parent table schema

Returns:

the parent table schema

getAllFields

public StoredFieldSchema[] getAllFields()

get all fields of the index

Returns:

all the fields of the index

setParent

public void setParent(StoredTableSchema parent)

Parameters:

parent - specifies the tableschema

addStoredFieldSchame

public void addStoredFieldSchame(StoredFieldSchema indexfield)

adds a new stored field in the index

Parameters:

indexfield - the field to add at current position in the index

getFieldNumber

public int getFieldNumber()

get the number of fields in this index

Returns:

the number of fields

getField

public StoredFieldSchema getField(int i)

gets a field in the index

Parameters:

i - a field between 0 (included) and getFieldNumber() (excluded)

Returns:

the field at the specified index

getFullName

public java.lang.String getFullName()

generates the name in the database

Returns:

the name to use to store the index in the databse