Produced by Siminov Software Solution LLP

siminov.orm.model
Class DatabaseMappingDescriptor.Index

java.lang.Object
  extended by siminov.orm.model.DatabaseMappingDescriptor.Index
Enclosing class:
DatabaseMappingDescriptor

public static class DatabaseMappingDescriptor.Index
extends java.lang.Object

Exposes methods to GET and SET Reference Map information as per define in DatabaseMappingDescriptor.si.xml file by application.


Example:
        <index name="LIQUOR_INDEX_BASED_ON_LINK" unique="true">
                <column>HISTORY</column>
        </index>
        

                


Constructor Summary
DatabaseMappingDescriptor.Index()
           
 
Method Summary
 void addColumn(java.lang.String column)
          Add column to index.
 boolean containsColumn(java.lang.String column)
          Check whether index contain column or not.
 java.util.Iterator<java.lang.String> getColumns()
          Get all columns.
 java.lang.String getName()
          Get index name.
 boolean isUnique()
          Check whether index should be unique or not.
 void removeColumn(java.lang.String column)
          Remove column from index.
 void setName(java.lang.String name)
          Set index name as per defined in DatabaseMapping.core.xml file.
 void setUnique(boolean unique)
          Set whether unqiue is unique or not.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatabaseMappingDescriptor.Index

public DatabaseMappingDescriptor.Index()
Method Detail

getName

public java.lang.String getName()
Get index name.

Returns:
Index Name.

setName

public void setName(java.lang.String name)
Set index name as per defined in DatabaseMapping.core.xml file.

Parameters:
name - Index Name.

isUnique

public boolean isUnique()
Check whether index should be unique or not.

Returns:
TRUE: If index is unique, FALSE: If index is not unqiue.

setUnique

public void setUnique(boolean unique)
Set whether unqiue is unique or not.

Parameters:
unique - TRUE: If index is unique, FALSE: If index is not unique.

containsColumn

public boolean containsColumn(java.lang.String column)
Check whether index contain column or not.

Parameters:
column - Name of column.
Returns:
TRUE: If index contains column, FALSE: If index does not contain column.

getColumns

public java.util.Iterator<java.lang.String> getColumns()
Get all columns.

Returns:
Iterator which contain all columns.

addColumn

public void addColumn(java.lang.String column)
Add column to index.

Parameters:
column - Name of column.

removeColumn

public void removeColumn(java.lang.String column)
Remove column from index.

Parameters:
column - Name of column.

Apache License 2.0

Copyright 2013