OpenPetra
Free Administration Software for Non-Profits
Ict.Tools.DBXML.TIndex Class Reference

data of an index More...

Public Member Functions

 TIndex ()
 constructor More...
 
bool SimilarFields (TIndex i, bool checkSortingOrder)
 compare if two indexes have the same fields, optional checking the sorting order More...
 
bool Similar (TIndex i)
 compare two indexes whether they are the same More...
 

Static Public Member Functions

static String MakeIndexName (String AKeyName, String AMsg, string APostfix)
 Progress has a maximum length for the index name More...
 

Public Attributes

String strName
 name of the index More...
 
String strDescr
 description More...
 
String strArea
 which area this index belongs to More...
 
bool bPrimary
 used for primary key index in some DBMS More...
 
bool bUnique
 unique index, no duplicates allowed More...
 
bool bImplicit
 implicit = true means: this index can be derived from a key More...
 
List< TIndexFieldgrpIndexField
 the fields that are part of this index More...
 
ArrayList aliases
 list of strings, names of similar indexes (not added) More...
 

Detailed Description

data of an index

Constructor & Destructor Documentation

◆ TIndex()

Ict.Tools.DBXML.TIndex.TIndex ( )
inline

constructor

Member Function Documentation

◆ MakeIndexName()

static String Ict.Tools.DBXML.TIndex.MakeIndexName ( String  AKeyName,
String  AMsg,
string  APostfix 
)
inlinestatic

Progress has a maximum length for the index name

Parameters
AKeyName
AMsg
APostfix
Returns

◆ Similar()

bool Ict.Tools.DBXML.TIndex.Similar ( TIndex  i)
inline

compare two indexes whether they are the same

Parameters
ithe index to compare
Returns
true if same fields and uniqueness

◆ SimilarFields()

bool Ict.Tools.DBXML.TIndex.SimilarFields ( TIndex  i,
bool  checkSortingOrder 
)
inline

compare if two indexes have the same fields, optional checking the sorting order

Parameters
ithe index to compare with
checkSortingOrdershould the sorting order be checked as well
Returns
true if same fields are part of each index

Member Data Documentation

◆ aliases

ArrayList Ict.Tools.DBXML.TIndex.aliases

list of strings, names of similar indexes (not added)

◆ bImplicit

bool Ict.Tools.DBXML.TIndex.bImplicit

implicit = true means: this index can be derived from a key

◆ bPrimary

bool Ict.Tools.DBXML.TIndex.bPrimary

used for primary key index in some DBMS

◆ bUnique

bool Ict.Tools.DBXML.TIndex.bUnique

unique index, no duplicates allowed

◆ grpIndexField

List<TIndexField> Ict.Tools.DBXML.TIndex.grpIndexField

the fields that are part of this index

◆ strArea

String Ict.Tools.DBXML.TIndex.strArea

which area this index belongs to

◆ strDescr

String Ict.Tools.DBXML.TIndex.strDescr

description

◆ strName

String Ict.Tools.DBXML.TIndex.strName

name of the index


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