org.molgenis.model.elements

Class Index

java.lang.Object

org.molgenis.model.elements.Index

All Implemented Interfaces:

Serializable

public class Index
extends Object
implements Serializable

This class describes a single index-field. An index makes a column (or multiple columns) faster to search (binary tree idea). It can index multiple columns at the same time.

Version:

1.0.0

Author:

RA Scheltema

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Index(String name) Default constructor, which sets the name of the index.

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(String field) Adds the field-name to the list of fields.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
Vector<String>	getFields() Returns a vector with all the field-names this index indexes.
String	getName() Returns the name of the index.
int	hashCode() Returns a hash code value for the Field.
String	toString() Returns a string representation of the Index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Index

public Index(String name)

Default constructor, which sets the name of the index. The fields vector remains empty.

Parameters:

name - The name of the index.

Method Detail

getName

public String getName()

Returns the name of the index.

Returns:

The name of the index.

addField

public void addField(String field)
              throws MolgenisModelException

Adds the field-name to the list of fields. The field-name needs to be unique in the list of fields, otherwise an exception is generated.

Parameters:

field - The name of the field this index indexes.

Throws:

Exception - When the name is already present.

MolgenisModelException

getFields

public Vector<String> getFields()

Returns a vector with all the field-names this index indexes.

Returns:

Vector with all the field-names.

toString

public String toString()

Returns a string representation of the Index.

Overrides:

toString in class Object

Returns:

The string-representation.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - The reference object with which to compare.

Returns:

True if this object is the same as the obj argument, false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the Field. This hash-code is used for quick searching in a vector of fields.

Overrides:

hashCode in class Object

Returns:

The hash-value for this field.