DSIExtIndexMetadataList Class Reference

Inherits Simba::SQLEngine::IIndexMetadataList.

List of all members.

Public Member Functions

void AddIndexMetadata (AutoPtr< IIndexMetadata > in_metadata)
 Adds an IIndexMetadata to this list.
 DSIExtIndexMetadataList (AutoVector< IIndexMetadata > &in_metadata, bool in_indexNameIsCaseSensitive=false)
 Constructor.
 DSIExtIndexMetadataList (bool in_indexNameIsCaseSensitive=false)
 Constructor.
virtual simba_size_t GetIndexCount () const
 Returns the index count.
IIndexMetadataGetIndexMetadata (const simba_wstring &in_indexName)
 Returns a reference to the desired index metadata.
virtual const IIndexMetadataGetIndexMetadata (const simba_wstring &in_indexName) const
 Returns a reference to the desired index metadata.
IIndexMetadataGetIndexMetadata (simba_size_t in_index)
 Returns a reference to the desired index metadata.
virtual const IIndexMetadataGetIndexMetadata (simba_size_t in_index) const
 Returns a reference to the desired index metadata.
AutoPtr< IIndexMetadataRemoveIndexMetadata (const simba_wstring &in_indexName)
 Removes an IIndexMetadata object from this list.
AutoPtr< IIndexMetadataRemoveIndexMetadata (simba_size_t in_index)
 Removes an IIndexMetadata object from this list.

Constructor & Destructor Documentation

DSIExtIndexMetadataList ( bool  in_indexNameIsCaseSensitive = false  ) 

Constructor.

Parameters:
in_indexNameIsCaseSensitive Whether index names are case sensitive. False by default.
DSIExtIndexMetadataList ( AutoVector< IIndexMetadata > &  in_metadata,
bool  in_indexNameIsCaseSensitive = false 
) [explicit]

Constructor.

Parameters:
in_metadata Index metadata to take ownership of.
in_indexNameIsCaseSensitive Whether index names are case sensitive. False by default.

Member Function Documentation

void AddIndexMetadata ( AutoPtr< IIndexMetadata in_metadata  ) 

Adds an IIndexMetadata to this list.

in_metadata must have a unique name.

Parameters:
in_metadata The IIndexMetadata object to add to this list.
Exceptions:
SEInvalidArgumentException if in_metadata is NULL, or if there already exists and IIndexMetadata object with the same name in this list.
virtual simba_size_t GetIndexCount (  )  const [virtual]

Returns the index count.

Returns:
Index count.

Implements IIndexMetadataList.

IIndexMetadata* GetIndexMetadata ( const simba_wstring in_indexName  ) 

Returns a reference to the desired index metadata.

Parameters:
in_indexName The unique name of the index for which to retrieve metadata.
Returns:
The metadata for the given index, or NULL if it was not found. (NOT OWN)
virtual const IIndexMetadata* GetIndexMetadata ( const simba_wstring in_indexName  )  const [virtual]

Returns a reference to the desired index metadata.

Parameters:
in_indexName The unique name of the index for which to retrieve metadata. Case-Insensitive.
Returns:
The metadata for the given index, or NULL if it was not found. (NOT OWN)

Implements IIndexMetadataList.

IIndexMetadata* GetIndexMetadata ( simba_size_t  in_index  ) 

Returns a reference to the desired index metadata.

Parameters:
in_index The number of the index for which to retrieve metadata. Indexes are indexed starting with 0.
Exceptions:
SEInvalidArgumentException if in_index is out of range.
Returns:
The metadata for the given index. (NOT OWN)
virtual const IIndexMetadata* GetIndexMetadata ( simba_size_t  in_index  )  const [virtual]

Returns a reference to the desired index metadata.

Parameters:
in_index The number of the index for which to retrieve metadata. Indexes are indexed starting with 0.
Exceptions:
SEInvalidArgumentException if in_index is out of range.
Returns:
The metadata for the given index. (NOT OWN)

Implements IIndexMetadataList.

AutoPtr<IIndexMetadata> RemoveIndexMetadata ( const simba_wstring in_indexName  ) 

Removes an IIndexMetadata object from this list.

Parameters:
in_indexName The unique name of the index for which to retrieve metadata.
Returns:
The removed object, or NULL if it wasn't found.
AutoPtr<IIndexMetadata> RemoveIndexMetadata ( simba_size_t  in_index  ) 

Removes an IIndexMetadata object from this list.

Parameters:
in_index The index of the object to remove. Indexes are indexed starting with 0.
Exceptions:
SEInvalidArgumentException if in_index is out of range.
Returns:
The removed object.

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