Package org.compiere.model

Class MTableIndex

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_TableIndex

org.compiere.model.MTableIndex

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_TableIndex, I_Persistent, Evaluatee

public class MTableIndex
extends X_AD_TableIndex

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_TableIndex

ENTITYTYPE_AD_Reference_ID

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_TableIndex

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Message_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_TableIndex_ID, COLUMNNAME_AD_TableIndex_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_EntityType, COLUMNNAME_Help, COLUMNNAME_IsActive, COLUMNNAME_IsCreateConstraint, COLUMNNAME_IsKey, COLUMNNAME_IsUnique, COLUMNNAME_Name, COLUMNNAME_Processing, COLUMNNAME_TableIndexDrop, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MTableIndex(Properties ctx, int AD_TableIndex_ID, String trxName)	Standard constructor
MTableIndex(Properties ctx, String AD_TableIndex_UU, String trxName)	UUID based Constructor
MTableIndex(Properties ctx, ResultSet rs, String trxName)	Load constructor
MTableIndex(MTable parent, String name)	Parent constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeSave(boolean newRecord)	Called before Save for Pre-Save Operation. Default implementation is nop, to be implemented in sub-classes that needed it.
static MTableIndex[]	get(MTable table)	Get active indexes of table
MIndexColumn[]	getColumns(boolean reload)	Get index columns
MIndexColumn[]	getColumns(boolean reload, boolean activeOnly)	Get index columns
String	getDDL()	Get create index or constraint (if IsCreateConstraint=Y) DDL
String	getDropDDL()	Get drop index or constraint (if IsCreateConstraint=Y) DDL
static List<MTableIndex>	getTableIndexesByQuery(Properties ctx, String whereClause)	Get table indexes with where clause
String	getTableName()	Get table name
String	toString()	String representation

Methods inherited from class org.compiere.model.X_AD_TableIndex

get_AccessLevel, getAD_Message, getAD_Message_ID, getAD_Table, getAD_Table_ID, getAD_TableIndex_ID, getAD_TableIndex_UU, getDescription, getEntityType, getHelp, getKeyNamePair, getName, getTableIndexDrop, initPO, isCreateConstraint, isKey, isProcessing, isUnique, setAD_Message_ID, setAD_Table_ID, setAD_TableIndex_ID, setAD_TableIndex_UU, setDescription, setEntityType, setHelp, setIsCreateConstraint, setIsKey, setIsUnique, setName, setProcessing, setTableIndexDrop

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_TableIndex

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Details

MTableIndex

public MTableIndex(Properties ctx,
 String AD_TableIndex_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_TableIndex_UU - UUID key

trxName - Transaction

MTableIndex

public MTableIndex(Properties ctx,
 int AD_TableIndex_ID,
 String trxName)

Standard constructor

Parameters:

ctx - context

AD_TableIndex_ID - table index

trxName - trx name

MTableIndex

public MTableIndex(Properties ctx,
 ResultSet rs,
 String trxName)

Load constructor

Parameters:

ctx - context

rs - result set

trxName - trx name

MTableIndex

public MTableIndex(MTable parent,
 String name)

Parent constructor

Parameters:

parent - parent

name - index name

Method Details

get

public static MTableIndex[] get(MTable table)

Get active indexes of table

Parameters:

table - table

Returns:

array of table index

getTableIndexesByQuery

public static List<MTableIndex> getTableIndexesByQuery(Properties ctx,
 String whereClause)

Get table indexes with where clause

Parameters:

ctx - context

whereClause - SQL where clause

Returns:

list of table index

getColumns

public MIndexColumn[] getColumns(boolean reload)

Get index columns

Parameters:

reload - true to reload from DB

Returns:

array of index column

getColumns

public MIndexColumn[] getColumns(boolean reload,
 boolean activeOnly)

Get index columns

Parameters:

reload - true to reload from DB

activeOnly - return active records only

Returns:

array of index column

getTableName

public String getTableName()

Get table name

Returns:

table name

getDDL

public String getDDL()

Get create index or constraint (if IsCreateConstraint=Y) DDL

Returns:

Create Index or Constraint DDL

getDropDDL

public String getDropDDL()

Get drop index or constraint (if IsCreateConstraint=Y) DDL

Returns:

Drop Index or Constraint DDL

beforeSave

protected boolean beforeSave(boolean newRecord)

Description copied from class: PO

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

Overrides:

beforeSave in class PO

Parameters:

newRecord - true if it is a new record

Returns:

true if record can be saved

toString

public String toString()

String representation

Overrides:

toString in class X_AD_TableIndex

Returns:

info