Class IndexDefinition
java.lang.Object
org.springframework.data.gemfire.config.schema.SchemaObjectDefinition
org.springframework.data.gemfire.config.schema.definitions.IndexDefinition
- All Implemented Interfaces:
Serializable
,Ordered
IndexDefinition
is an Abstract Data Type (ADT) encapsulating the configuration meta-data used to define
a new Apache Geode / Pivotal GemFire Region
Index
.- Since:
- 2.0.0
- Author:
- John Blum
- See Also:
-
Nested Class Summary
-
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
ModifierConstructorDescriptionprotected
IndexDefinition
(Index index) Constructs a new instance ofIndexDefinition
defined with the givenIndex
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
create
(GemfireAdminOperations gemfireAdminOperations) Creates an actual schema object from thisSchemaObjectDefinition
.static IndexDefinition
Factory method used to construct a new instance ofIndexDefinition
defined from the givenIndex
.protected Index
getIndex()
Returns a reference to theIndex
on which this definition is defined.getName()
Returns thename
assigned to the schema object.int
getOrder()
Get the order value of this object.getType()
Returns thetype
of schema object defined by thisSchemaObjectDefinition
.Methods inherited from class org.springframework.data.gemfire.config.schema.SchemaObjectDefinition
equals, hashCode, toString
-
Field Details
-
ORDER
protected static final int ORDER- See Also:
-
-
Constructor Details
-
IndexDefinition
Constructs a new instance ofIndexDefinition
defined with the givenIndex
.- Parameters:
index
-Index
on which this definition is defined; must not be null.- Throws:
IllegalArgumentException
- ifIndex
is null.- See Also:
-
-
Method Details
-
from
Factory method used to construct a new instance ofIndexDefinition
defined from the givenIndex
.- Parameters:
index
-Index
on which the newIndexDefinition
will be defined; must not be null.- Returns:
- a new instance of
IndexDefinition
defined from the givenIndex
. - Throws:
IllegalArgumentException
- ifIndex
is null.- See Also:
-
getIndex
Returns a reference to theIndex
on which this definition is defined. -
getName
Description copied from class:SchemaObjectDefinition
Returns thename
assigned to the schema object.- Overrides:
getName
in classSchemaObjectDefinition
- Returns:
- the
name
assigned to the schema object; name is never null.
-
getExpression
-
getFromClause
-
getIndexType
-
getOrder
public int getOrder()Get the order value of this object.- Returns:
- the order value of this object.
- See Also:
-
getType
Description copied from class:SchemaObjectDefinition
Returns thetype
of schema object defined by thisSchemaObjectDefinition
.- Specified by:
getType
in classSchemaObjectDefinition
- Returns:
- the
type
of schema object defined by thisSchemaObjectDefinition
. - See Also:
-
create
Description copied from class:SchemaObjectDefinition
Creates an actual schema object from thisSchemaObjectDefinition
.- Overrides:
create
in classSchemaObjectDefinition
- Parameters:
gemfireAdminOperations
-GemfireAdminOperations
used to create an actual schema object from thisSchemaObjectDefinition
.- See Also:
-
as
-
as
-
having
-
on
-
on
-
with
-