IndexImpl (Tentackle Data Model 8.2.8.0 API)

java.lang.Object
- org.tentackle.model.impl.IndexImpl

All Implemented Interfaces:

Index, ModelElement
```
public class IndexImpl
extends Object
implements Index
```
Index descriptor.
An index line is of the form:
```
   [unique] index <name> := part1[ part2 ...]
 
```
where part is:
```
   [+|-]<column> | <function>(<column>) [asc|desc]
 
```
where:
- name: is the index name (the table-name will be prepended, separated by an underscore)
- column: is either the database column-name of the entity attribute name
- function: is a function name
- ASC or + for ascending order (default)
- DESC or - for descending order
Examples:
```
   unique index udk := code
   index locid := location_id desc name
   index ucmt := -upper(comment)
 
```
Author:

harald

Constructor Summary

Constructors
Constructor and Description

IndexImpl(EntityFactoryImpl factory, Entity entity, SourceInfo sourceInfo)
Creates an index.

Constructors
Constructor and Description
`IndexImpl(EntityFactoryImpl factory, Entity entity, SourceInfo sourceInfo)` Creates an index.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`createDatabaseIndexName(Entity entity)` Creates the database index name for given entity.
`ModelException`	`createModelException(String message)` Creates a model exception.
`List<IndexAttribute>`	`getAttributes()` Gets the index attributes.
`String`	`getComment()` Gets the comment.
`Entity`	`getEntity()` Gets the entity this index belongs to.
`String`	`getFilterCondition()` Gets the optional filter condition.
`String`	`getName()` Gets the name of the element.
`ModelElement`	`getParent()` Gets the parent element.
`SourceInfo`	`getSourceInfo()` Gets the information about the source where this element is defined.
`ConfigurationLine`	`getSourceLine()` Gets the source line.
`boolean`	`isLogicallyEqualTo(Index otherIndex)` Checks whether other index is logically equal to this index.
`boolean`	`isParsed()` Returns whether index is already parsed. Indexes are parsed delayed because some attributes may be added later when the whole model is known.
`boolean`	`isUnique()` Returns whether the index is unique.
`void`	`parse(Entity entity)` Parses a configuration line.
`void`	`setComment(String comment)`
`void`	`setFilterCondition(String filterCondition)`
`void`	`setName(String name)`
`void`	`setParsed(boolean parsed)` Sets the index to be parsed. Only necessary for model converters if the properties are set explicitly to prevent parsing.
`void`	`setSourceLine(ConfigurationLine sourceLine)` Sets the source line.
`void`	`setUnique(boolean unique)`
`String`	`sqlCreateIndex(Backend backend, Entity entity)` Creates the index creation sql code.
`String`	`toString()`
`void`	`validate()` Validates the index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IndexImpl
```
public IndexImpl(EntityFactoryImpl factory,
                 Entity entity,
                 SourceInfo sourceInfo)
```
    Creates an index.
    
    Parameters:
    
    factory - the factory to create indexes
    
    entity - the entity this index belongs to
    
    sourceInfo - the source info
- Method Detail
  - getEntity
```
public Entity getEntity()
```
    Description copied from interface: Index
    
    Gets the entity this index belongs to.
    
    Specified by:
    
    getEntity in interface Index
    
    Returns:
    
    the entity
  - getSourceInfo
```
public SourceInfo getSourceInfo()
```
    Description copied from interface: ModelElement
    
    Gets the information about the source where this element is defined.
    
    Specified by:
    
    getSourceInfo in interface ModelElement
    
    Returns:
    
    the source info
  - getParent
```
public ModelElement getParent()
```
    Description copied from interface: ModelElement
    
    Gets the parent element.
    
    Specified by:
    
    getParent in interface ModelElement
    
    Returns:
    
    the parent, null if none
  - parse
```
public void parse(Entity entity)
           throws ModelException
```
    Parses a configuration line.
    
    Parameters:
    
    entity - the entity
    
    Throws:
    
    ModelException - if parsing the model failed
  - getName
```
public String getName()
```
    Description copied from interface: ModelElement
    
    Gets the name of the element.
    
    Specified by:
    
    getName in interface ModelElement
    
    Returns:
    
    the name
  - createDatabaseIndexName
```
public String createDatabaseIndexName(Entity entity)
```
    Description copied from interface: Index
    
    Creates the database index name for given entity.
    
    Specified by:
    
    createDatabaseIndexName in interface Index
    
    Parameters:
    
    entity - the entity
    
    Returns:
    
    the effective sql name
  - getComment
```
public String getComment()
```
    Description copied from interface: Index
    
    Gets the comment.
    
    Specified by:
    
    getComment in interface Index
    
    Returns:
    
    the comment
  - isUnique
```
public boolean isUnique()
```
    Description copied from interface: Index
    
    Returns whether the index is unique.
    
    Specified by:
    
    isUnique in interface Index
    
    Returns:
    
    true if unique, else non-unique
  - getFilterCondition
```
public String getFilterCondition()
```
    Description copied from interface: Index
    
    Gets the optional filter condition.
    
    Specified by:
    
    getFilterCondition in interface Index
    
    Returns:
    
    the condition, null if none
  - getAttributes
```
public List<IndexAttribute> getAttributes()
```
    Description copied from interface: Index
    
    Gets the index attributes.
    
    Specified by:
    
    getAttributes in interface Index
    
    Returns:
    
    the attributes
  - setName
```
public void setName(String name)
```
  - setComment
```
public void setComment(String comment)
```
  - setUnique
```
public void setUnique(boolean unique)
```
  - setFilterCondition
```
public void setFilterCondition(String filterCondition)
```
  - setParsed
```
public void setParsed(boolean parsed)
```
    Sets the index to be parsed.
    Only necessary for model converters if the properties are set explicitly to prevent parsing.
    
    Parameters:
    
    parsed - true if don't parse anymore
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isParsed
```
public boolean isParsed()
```
    Returns whether index is already parsed.
    Indexes are parsed delayed because some attributes may be added later when the whole model is known.
    
    Returns:
    
    true if parsed
  - validate
```
public void validate()
              throws ModelException
```
    Description copied from interface: Index
    
    Validates the index.
    
    Specified by:
    
    validate in interface Index
    
    Throws:
    
    ModelException - if validation failed
  - getSourceLine
```
public ConfigurationLine getSourceLine()
```
    Gets the source line.
    
    Returns:
    
    the line
  - setSourceLine
```
public void setSourceLine(ConfigurationLine sourceLine)
```
    Sets the source line.
    
    Parameters:
    
    sourceLine - the line
  - createModelException
```
public ModelException createModelException(String message)
```
    Creates a model exception.
    Refers to the source line if set, otherwise just the message.
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the exception
  - sqlCreateIndex
```
public String sqlCreateIndex(Backend backend,
                             Entity entity)
```
    Description copied from interface: Index
    
    Creates the index creation sql code.
    
    Specified by:
    
    sqlCreateIndex in interface Index
    
    Parameters:
    
    backend - the backend to create sql code for
    
    entity - the entity to create the index for
    
    Returns:
    
    the SQL code
  - isLogicallyEqualTo
```
public boolean isLogicallyEqualTo(Index otherIndex)
```
    Checks whether other index is logically equal to this index.
    
    Parameters:
    
    otherIndex - the other index
    
    Returns:
    
    true if equal

Class IndexImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IndexImpl

Method Detail

getEntity

getSourceInfo

getParent

parse

getName

createDatabaseIndexName

getComment

isUnique

getFilterCondition

getAttributes

setName

setComment

setUnique

setFilterCondition

setParsed

toString

isParsed

validate

getSourceLine

setSourceLine

createModelException

sqlCreateIndex

isLogicallyEqualTo