DSIExtIndexMetadata Class Reference

Represents the metadata for a single index. More...

Inherits Simba::SQLEngine::IIndexMetadata.

List of all members.

Public Member Functions

 DSIExtIndexMetadata (const simba_wstring &in_name, DSIExtIndexType in_type, IndexColumns &in_columns)
 Constructor.
virtual const IndexColumnsGetIndexColumns () const
 Get the columns involved in the index.
virtual const simba_wstringGetName () const
 Get the name of the index.
virtual DSIExtIndexType GetType () const
 Get the type of the index.
virtual bool IsPrimaryKey () const
 Get if the index is the primary key.
virtual bool IsUnique () const
 Get if the index is a unique index.
void SetPrimaryKey (bool in_isPrimaryKey)
 Set if the index is the primary key.
void SetType (DSIExtIndexType in_type)
 Set the type of the index.
void SetUnique (bool in_isUnique)
 Set if the index is unique.

Detailed Description

Represents the metadata for a single index.

Allows for retrieval of metadata about the index, such as name, included columns, type, and so on.


Constructor & Destructor Documentation

DSIExtIndexMetadata ( const simba_wstring in_name,
DSIExtIndexType  in_type,
IndexColumns in_columns 
)

Constructor.

Parameters:
in_name The name of the index.
in_type The type of the index.
in_columns The columns involved in the index, in the order they appear in the index. Takes ownership of the objects held. (in_columns will be empty after the constructor returns)

Member Function Documentation

virtual const IndexColumns& GetIndexColumns (  )  const [virtual]

Get the columns involved in the index.

The columns should appear in the same order that they are in the index.

Returns:
The columns involved in the index.

Implements IIndexMetadata.

virtual const simba_wstring& GetName (  )  const [virtual]

Get the name of the index.

Returns:
The name of the index.

Implements IIndexMetadata.

virtual DSIExtIndexType GetType (  )  const [virtual]

Get the type of the index.

Returns:
The type of the index.

Implements IIndexMetadata.

virtual bool IsPrimaryKey (  )  const [virtual]

Get if the index is the primary key.

Note that only one index should be the primary key for any table. Defaults to false.

Returns:
True if the index is the primary key; false otherwise.

Implements IIndexMetadata.

virtual bool IsUnique (  )  const [virtual]

Get if the index is a unique index.

Defaults to false.

Returns:
True if the index is a unique index; false otherwise.

Implements IIndexMetadata.

void SetPrimaryKey ( bool  in_isPrimaryKey  ) 

Set if the index is the primary key.

Parameters:
in_isPrimaryKey True if the index is the primary key; false otherwise.
void SetType ( DSIExtIndexType  in_type  ) 

Set the type of the index.

Parameters:
in_type The type of the index.
void SetUnique ( bool  in_isUnique  ) 

Set if the index is unique.

Parameters:
in_isUnique True if the index is unique; false otherwise.

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

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba