public interface IndexDefinition extends Iterable<IndexColumnDefinition>
Modifier and Type | Interface and Description |
---|---|
static class |
IndexDefinition.IndexKind
The kind of indexes.
|
static interface |
IndexDefinition.WorkspaceMatchRule |
Modifier and Type | Method and Description |
---|---|
boolean |
appliesToProperty(String propertyName)
Determine if this index definition has a column that applies to the named property.
|
IndexColumnDefinition |
getColumnDefinition(int position)
Get the definition for the index column at the given 0-based position.
|
String |
getDescription()
Get the description of this index.
|
Map<String,Object> |
getIndexProperties()
Get the index property values keyed by their name.
|
Object |
getIndexProperty(String propertyName)
Get the index property with the given name.
|
IndexDefinition.IndexKind |
getKind()
Get the kind of index.
|
String |
getName()
Get the name of this index.
|
String |
getNodeTypeName()
Get the name of the node type for which this index applies.
|
String |
getProviderName()
Get the name of the provider that owns this index.
|
IndexDefinition.WorkspaceMatchRule |
getWorkspaceMatchRule()
Get the rule that defines the workspaces to which this index definition applies.
|
boolean |
hasSingleColumn()
Determine whether this index has a single column.
|
boolean |
isEnabled()
Determine whether this index is currently enabled.
|
boolean |
isSynchronous()
Determine whether this index is updated synchronously.
|
int |
size()
Get the number of columns in this index.
|
forEach, iterator, spliterator
String getName()
String getProviderName()
IndexDefinition.IndexKind getKind()
String getNodeTypeName()
String getDescription()
boolean isEnabled()
boolean isSynchronous()
boolean hasSingleColumn()
int size()
IndexColumnDefinition getColumnDefinition(int position) throws NoSuchElementException
position
- the 0-based position; must be less than size()
NoSuchElementException
- if the position is negative or greater than or equal to size()
.Object getIndexProperty(String propertyName)
propertyName
- the property name; may not be nullMap<String,Object> getIndexProperties()
IndexDefinition.WorkspaceMatchRule getWorkspaceMatchRule()
boolean appliesToProperty(String propertyName)
for (IndexColumnDefinition columnDefn : this) { if (columnDefn.getPropertyName().equals(propertyName)) return true; } return false;
propertyName
- the name of the propertyCopyright © 2008–2016 JBoss, a division of Red Hat. All rights reserved.