org.openlowcode.design.data

Class Index

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.Index

All Implemented Interfaces:

NamedInterface

public class Index
extends Named

A binary search index on a stored element. The indexes can be unique, though this is not recommended, as it may have side effects in many special situations

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
Index(java.lang.String name, java.util.ArrayList<StoredElement> fields, boolean unique) creates an index with several fields
Index(java.lang.String name, StoredElement simpleelement, boolean unique) creates an index with one stored element
Index(java.lang.String name, StoredElement element1, StoredElement element2, boolean unique) creates an index with two stored elements

Method Summary

Modifier and Type	Method and Description
StoredElement	getFieldAtIndex(int index) return the stored element at the given index
int	getStoredElementNumber()
boolean	isUnique()

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

Index

public Index(java.lang.String name,
             StoredElement simpleelement,
             boolean unique)

creates an index with one stored element

Parameters:

name - unique name of the index (should be short and valid sql and java element)

simpleelement - the stored element that is indexed

unique - true if index is unique

Index

public Index(java.lang.String name,
             StoredElement element1,
             StoredElement element2,
             boolean unique)

creates an index with two stored elements

Parameters:

name - unique name of the index (should be short and valid sql and java element)

element1 - first element for the index (should be the most discriminant and / or used)

element2 - second element for the index

unique - true if index is unique

Index

public Index(java.lang.String name,
             java.util.ArrayList<StoredElement> fields,
             boolean unique)

creates an index with several fields

Parameters:

name - unique name of the index (should be short and valid sql and java element)

fields - a list of fields (will be indexed in the order proided

unique - true if index is unique

Method Detail

getStoredElementNumber

public int getStoredElementNumber()

Returns:

the number of stored elements

getFieldAtIndex

public StoredElement getFieldAtIndex(int index)

return the stored element at the given index

Parameters:

index - an index between 0 (included) and getStoredElementNumber (excluded)

Returns:

the StoredElement at the given index

isUnique

public boolean isUnique()

Returns:

true if the index will enforce unicity