SICIndex Class Reference
Inherits from | NSObject |
---|---|
Conforms to | SICIDescriptor |
Declared in | SICDatabaseMappingDescriptor.h SICDatabaseMappingDescriptor.m SICEntityDescriptor.h SICEntityDescriptor.m |
Overview
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>
Other Methods
– getName
Get index name.
- (NSString *)getName
Return Value
Index Name.
Discussion
Get index name.
Declared In
SICDatabaseMappingDescriptor.h
– setName:
Set index name as per defined in DatabaseMapping.core.xml file.
- (void)setName:(NSString *)name
Parameters
name |
Index Name. |
---|
Discussion
Set index name as per defined in DatabaseMapping.core.xml file.
Declared In
SICDatabaseMappingDescriptor.h
– isUnique
Check whether index should be unique or not.
- (BOOL)isUnique
Return Value
TRUE: If index is unique, FALSE: If index is not unqiue.
Discussion
Check whether index should be unique or not.
Declared In
SICDatabaseMappingDescriptor.h
– setUnique:
Set whether unqiue is unique or not.
- (void)setUnique:(BOOL const)unique
Parameters
unique |
TRUE: If index is unique, FALSE: If index is not unique. |
---|
Discussion
Set whether unqiue is unique or not.
Declared In
SICDatabaseMappingDescriptor.h
– containsColumn:
Check whether index contain column or not.
- (BOOL)containsColumn:(NSString *const)column
Parameters
column |
Name of column. |
---|
Return Value
TRUE: If index contains column, FALSE: If index does not contain column.
Discussion
Check whether index contain column or not.
Declared In
SICDatabaseMappingDescriptor.h
– getColumns
Get all columns.
- (NSEnumerator *)getColumns
Return Value
Iterator which contain all columns.
Discussion
Get all columns.
Declared In
SICDatabaseMappingDescriptor.h
– addColumn:
Add column to index.
- (void)addColumn:(NSString *const)column
Parameters
column |
Name of column. |
---|
Discussion
Add column to index.
Declared In
SICDatabaseMappingDescriptor.h
– removeColumn:
Remove column from index.
- (void)removeColumn:(NSString *const)column
Parameters
column |
Name of column. |
---|
Discussion
Remove column from index.
Declared In
SICDatabaseMappingDescriptor.h
Protocol Methods
– getProperties
Get all the properties of descriptor
- (NSEnumerator *)getProperties
Return Value
All properties
Discussion
Get all the properties of descriptor
Declared In
SICIDescriptor.h
– getProperty:
Get the property value based on the property name
- (NSString *)getProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Return Value
Value of the property
Discussion
Get the property value based on the property name
Declared In
SICIDescriptor.h
– containProperty:
Check whether property exists or not
- (BOOL)containProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Return Value
(true/false) TRUE: If property exists | FALSE: If property does not exists.
Discussion
Check whether property exists or not
Declared In
SICIDescriptor.h
– addProperty:value:
Add property to the descriptor
- (void)addProperty:(NSString *)name value:(NSString *)value
Parameters
name |
Name of the property |
---|---|
value |
Value of the property |
Discussion
Add property to the descriptor
Declared In
SICIDescriptor.h
– removeProperty:
Remove property from the descriptor
- (void)removeProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Discussion
Remove property from the descriptor
Declared In
SICIDescriptor.h