org.ofbiz.core.entity.model

Class ModelFunctionBasedIndex

java.lang.Object

org.ofbiz.core.entity.model.ModelFunctionBasedIndex

public class ModelFunctionBasedIndex
extends Object

Generic Entity - Relation model function-based-index class

Constructor Summary

Constructors

Constructor and Description
ModelFunctionBasedIndex(ModelEntity mainEntity, Element indexElement) XML Constructor
ModelFunctionBasedIndex(ModelEntity mainEntity, String name, boolean unique, FunctionDefinitionBuilder builder)

Method Summary

Modifier and Type	Method and Description
String	getFunction(DatabaseType dbType)
ModelEntity	getMainEntity() the main entity of this relation
String	getName() the index name, used for the database index name
String	getType()
boolean	getUnique() specifies whether or not this index should include the unique constraint
String	getVirtualColumn(DatabaseType dbType)
ModelField	getVirtualColumnModelField(DatabaseType dbType)
boolean	supportsFunctionBasedIndices(DatabaseType databaseType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelFunctionBasedIndex

public ModelFunctionBasedIndex(ModelEntity mainEntity,
                               String name,
                               boolean unique,
                               FunctionDefinitionBuilder builder)

ModelFunctionBasedIndex

public ModelFunctionBasedIndex(ModelEntity mainEntity,
                               Element indexElement)

XML Constructor

Method Detail

getName

public String getName()

the index name, used for the database index name

getFunction

public String getFunction(DatabaseType dbType)

getUnique

public boolean getUnique()

specifies whether or not this index should include the unique constraint

getVirtualColumn

public String getVirtualColumn(DatabaseType dbType)

getType

public String getType()

getMainEntity

public ModelEntity getMainEntity()

the main entity of this relation

getVirtualColumnModelField

public ModelField getVirtualColumnModelField(DatabaseType dbType)

supportsFunctionBasedIndices

public boolean supportsFunctionBasedIndices(DatabaseType databaseType)