IIndexMetadata Class Reference

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

Inherited by DSIExtIndexMetadata, and IUseableIndexMetadata.

List of all members.

Public Member Functions

virtual const
IUseableIndexMetadata
GetAsUseableIndexMetadata () const
 Get this object as an IUseableIndexMetadata.
IUseableIndexMetadataGetAsUseableIndexMetadata ()
 Get this object as an IUseableIndexMetadata.
virtual const IndexColumnsGetIndexColumns () const =0
 Get the indexed columns.
virtual const simba_wstringGetName () const =0
 Get the name of the index.
virtual DSIExtIndexType GetType () const =0
 Get the type of the index.
virtual bool IsPrimaryKey () const =0
 Get if the index is the primary key.
virtual bool IsUnique () const =0
 Get if the index is a unique index.
virtual bool IsUseable () const
 Get whether this index can be used by the SQLEngine.
virtual ~IIndexMetadata ()
 Destructor.

Protected Member Functions

 IIndexMetadata ()
 Constructor.

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

virtual ~IIndexMetadata (  )  [inline, virtual]

Destructor.

IIndexMetadata (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual const IUseableIndexMetadata* GetAsUseableIndexMetadata (  )  const [inline, virtual]

Get this object as an IUseableIndexMetadata.

This method should only be called if IsUseable() returns true.

Returns:
This object as an IUseableIndexMetadata. (NOT OWN)
Exceptions:
SEInvalidOperationException if this is not an IUseableIndexMetadata.

Reimplemented in IUseableIndexMetadata.

IUseableIndexMetadata* GetAsUseableIndexMetadata (  )  [inline]

Get this object as an IUseableIndexMetadata.

This method should only be called if IsUseable() returns true.

Returns:
This object as an IUseableIndexMetadata. (NOT OWN)
Exceptions:
SEInvalidOperationException if this is not an IUseableIndexMetadata.
virtual const IndexColumns& GetIndexColumns (  )  const [pure virtual]

Get the indexed columns.

Returns:
The columns involved in the index.

Implemented in DSIExtIndexMetadata, and IUseableIndexMetadata.

virtual const simba_wstring& GetName (  )  const [pure virtual]

Get the name of the index.

Returns:
The name of the index.

Implemented in DSIExtIndexMetadata, and IUseableIndexMetadata.

virtual DSIExtIndexType GetType (  )  const [pure virtual]

Get the type of the index.

Returns:
The type of the index.

Implemented in DSIExtIndexMetadata, and IUseableIndexMetadata.

virtual bool IsPrimaryKey (  )  const [pure virtual]

Get if the index is the primary key.

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

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

Implemented in DSIExtIndexMetadata, and IUseableIndexMetadata.

virtual bool IsUnique (  )  const [pure virtual]

Get if the index is a unique index.

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

Implemented in DSIExtIndexMetadata, and IUseableIndexMetadata.

virtual bool IsUseable (  )  const [inline, virtual]

Get whether this index can be used by the SQLEngine.

Returns:
True if this index can be used by the SQLEngine, false otherwise.

Reimplemented in IUseableIndexMetadata.


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

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