org.dbview.input_addons.DbIndex Class Reference

Collaboration diagram for org.dbview.input_addons.DbIndex:

List of all members.

Public Member Functions
	DbIndex (String in_table_name, Boolean in_unique, String in_index_name)
Boolean	isUnique ()
String	getIndexName ()
void	addField (Field in_field)
Boolean	containsField (Field in_field)
Integer	fieldCount ()
Field	getField (Integer in_pos) throws Exception
Public Attributes
String	table_name = null
String	index_name = null
ArrayList< Field >	fields = new ArrayList<Field>()
Boolean	unique = Boolean.FALSE

---

Detailed Description

This class represents an index.

Author:

Denis Beurive

Definition at line 31 of file DbIndex.java.

---

Constructor & Destructor Documentation

org.dbview.input_addons.DbIndex.DbIndex	(	String	in_table_name,
		Boolean	in_unique,
		String	in_index_name
	)

Create an index.

Parameters:

in_table_name	Name of the table.
in_unique	This argument indicates whether the index is unique or not. TRUE: The index is unique. FALSE: The index is not unique.
in_index_name	Name of the index.

Definition at line 63 of file DbIndex.java.

---

Member Function Documentation

void org.dbview.input_addons.DbIndex.addField

(

Field

in_field

)

This method adds a field to the list of fields that compose the index.

Parameters:

in_field

Field to add.

Definition at line 87 of file DbIndex.java.

Referenced by org.dbview.input_addons.AbstractLoader._indexes().

Boolean org.dbview.input_addons.DbIndex.containsField

(

Field

in_field

)

This method tests if a given field, represented by its name, is part of the index.

Parameters:

in_field

Field to add.

Returns:

Definition at line 94 of file DbIndex.java.

Integer org.dbview.input_addons.DbIndex.fieldCount

(

)

This method returns the number of fields that compose the index.

Returns:

The method returns the number of fields that compose the index.

Definition at line 100 of file DbIndex.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.__createIndexLabel(), org.dbview.db.structure.Table.getCompositeIndexes(), and org.dbview.db.structure.Table.getSimpleIndexes().

Field org.dbview.input_addons.DbIndex.getField

(

Integer

in_pos

)

throws Exception

This method returns a field given its position in the list of fields that composes the index.

Parameters:

in_pos

Position of the field to extract.

Returns:

The method returns the field at the given position.

Exceptions:

Exception

Definition at line 108 of file DbIndex.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.__createIndexLabel(), and org.dbview.input_addons.AbstractLoader.load().

String org.dbview.input_addons.DbIndex.getIndexName

(

)

This method returns the name of the index.

Returns:

This method returns the name of the index.

Definition at line 81 of file DbIndex.java.

Boolean org.dbview.input_addons.DbIndex.isUnique

(

)

This method tests whether the index is unique or not.

Returns:

If the index is unique, then the method returns the value TRUE. Otherwise, it returns the value FALSE.

Definition at line 75 of file DbIndex.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.__createIndexLabel().

---

Member Data Documentation

ArrayList<Field> org.dbview.input_addons.DbIndex.fields = new ArrayList<Field>()

List of fields that are part of the index.

Definition at line 46 of file DbIndex.java.

Referenced by org.dbview.input_addons.DbIndex.addField(), org.dbview.input_addons.DbIndex.containsField(), org.dbview.input_addons.DbIndex.fieldCount(), and org.dbview.input_addons.DbIndex.getField().

String org.dbview.input_addons.DbIndex.index_name = null

Name of the index.

Definition at line 41 of file DbIndex.java.

Referenced by org.dbview.input_addons.DbIndex.DbIndex(), and org.dbview.input_addons.DbIndex.getIndexName().

String org.dbview.input_addons.DbIndex.table_name = null

Name of the table that contains the index.

Definition at line 36 of file DbIndex.java.

Referenced by org.dbview.input_addons.DbIndex.DbIndex().

Boolean org.dbview.input_addons.DbIndex.unique = Boolean.FALSE

This field indicates whether the index is unique or not.

Definition at line 51 of file DbIndex.java.

Referenced by org.dbview.input_addons.DbIndex.DbIndex(), org.dbview.input_addons.DbIndex.isUnique(), and org.dbview.input_addons.AbstractLoader.load().

---

The documentation for this class was generated from the following file:

• src/org/dbview/input_addons/DbIndex.java