org.ofbiz.core.entity.model

Class ModelIndex

java.lang.Object

org.ofbiz.core.entity.model.ModelIndex

public class ModelIndex
extends Object

Generic Entity - Relation model class

Since:

2.0

Version:

$Revision: 1.1 $

Author:

David E. Jones

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IndexAlternativeAction>	alternativeActions
protected List<String>	fieldNames list of the field names included in this index
protected ModelEntity	mainEntity reference to the entity this index refers to
protected String	name the index name, used for the database index name
protected boolean	unique specifies whether or not this index should include the unique constraint

Constructor Summary

Constructors

Constructor and Description
ModelIndex() Default Constructor
ModelIndex(ModelEntity mainEntity, Element indexElement) XML Constructor

Method Summary

Modifier and Type	Method and Description
void	addAlternativeAction(IndexAlternativeAction indexAlternativeAction)
void	addIndexField(String fieldName)
Optional<IndexAlternativeAction>	getAlternativeIndexAction(DatabaseUtil dbUtil)
String	getIndexField(int index)
Iterator<String>	getIndexFieldsIterator()
int	getIndexFieldsSize()
ModelEntity	getMainEntity() the main entity of this relation
String	getName() the index name, used for the database index name
boolean	getUnique() specifies whether or not this index should include the unique constraint
String	removeIndexField(int index)
void	setMainEntity(ModelEntity mainEntity)
void	setName(String name)
void	setUnique(boolean unique)

Methods inherited from class java.lang.Object

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

Field Detail

mainEntity

protected ModelEntity mainEntity

reference to the entity this index refers to

name

protected String name

the index name, used for the database index name

unique

protected boolean unique

specifies whether or not this index should include the unique constraint

fieldNames

protected List<String> fieldNames

list of the field names included in this index

alternativeActions

protected List<IndexAlternativeAction> alternativeActions

Constructor Detail

ModelIndex

public ModelIndex()

Default Constructor

ModelIndex

public ModelIndex(ModelEntity mainEntity,
                  Element indexElement)

XML Constructor

Method Detail

getName

public String getName()

the index name, used for the database index name

setName

public void setName(String name)

getUnique

public boolean getUnique()

specifies whether or not this index should include the unique constraint

setUnique

public void setUnique(boolean unique)

getMainEntity

public ModelEntity getMainEntity()

the main entity of this relation

setMainEntity

public void setMainEntity(ModelEntity mainEntity)

getIndexFieldsIterator

public Iterator<String> getIndexFieldsIterator()

getIndexFieldsSize

public int getIndexFieldsSize()

getIndexField

public String getIndexField(int index)

addIndexField

public void addIndexField(String fieldName)

removeIndexField

public String removeIndexField(int index)

getAlternativeIndexAction

public Optional<IndexAlternativeAction> getAlternativeIndexAction(DatabaseUtil dbUtil)
                                                           throws SQLException,
                                                                  GenericEntityException

Throws:

SQLException

GenericEntityException

addAlternativeAction

public void addAlternativeAction(IndexAlternativeAction indexAlternativeAction)