Spring Data for VMware GemFire

java.lang.Object

org.springframework.data.gemfire.config.schema.SchemaObjectDefinition

org.springframework.data.gemfire.config.schema.definitions.IndexDefinition

All Implemented Interfaces:: Serializable, org.springframework.core.Ordered

public class IndexDefinition extends SchemaObjectDefinition

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

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected static final class

IndexDefinition.IndexWrapper
Field Summary

Fields

Modifier and Type

Field

Description

protected static final int

ORDER

Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

IndexDefinition(org.apache.geode.cache.query.Index index)

Constructs a new instance of IndexDefinition defined with the given Index.
Method Summary

Modifier and Type

Method

Description

IndexDefinition

as(org.apache.geode.cache.query.IndexType gemfireGeodeIndexType)

IndexDefinition

as(IndexType indexType)

void

create(GemfireAdminOperations gemfireAdminOperations)

Creates an actual schema object from this SchemaObjectDefinition.

static IndexDefinition

from(org.apache.geode.cache.query.Index index)

Factory method used to construct a new instance of IndexDefinition defined from the given Index.

String

getExpression()

String

getFromClause()

protected org.apache.geode.cache.query.Index

getIndex()

Returns a reference to the Index on which this definition is defined.

IndexType

getIndexType()

String

getName()

Returns the name assigned to the schema object.

int

getOrder()

Get the order value of this object.

SchemaObjectType

getType()

Returns the type of schema object defined by this SchemaObjectDefinition.

IndexDefinition

having(String expression)

IndexDefinition

on(String fromClause)

IndexDefinition

on(org.apache.geode.cache.Region<?,?> region)

IndexDefinition

with(String name)

Methods inherited from class org.springframework.data.gemfire.config.schema.SchemaObjectDefinition
equals, hashCode, toString

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

Field Details
- ORDER
  
  protected static final int ORDER
  See Also:
  
  Constant Field Values
Constructor Details
- IndexDefinition
  
  protected IndexDefinition(org.apache.geode.cache.query.Index index)
  
  Constructs a new instance of IndexDefinition defined with the given Index.
  Parameters:
  
  index - Index on which this definition is defined; must not be null.
  
  Throws:
  
  IllegalArgumentException - if Index is null.
  
  See Also:
  
  Index
Method Details
- from
  
  public static IndexDefinition from(org.apache.geode.cache.query.Index index)
  
  Factory method used to construct a new instance of IndexDefinition defined from the given Index.
  Parameters:
  
  index - Index on which the new IndexDefinition will be defined; must not be null.
  
  Returns:
  
  a new instance of IndexDefinition defined from the given Index.
  
  Throws:
  
  IllegalArgumentException - if Index is null.
  
  See Also:
  
  Index
- getIndex
  
  protected org.apache.geode.cache.query.Index getIndex()
  
  Returns a reference to the Index on which this definition is defined.
  Returns:
  
  a reference to the Index on which this definition is defined.
  
  See Also:
  
  Index
- getName
  
  public String getName()
  
  Description copied from class: SchemaObjectDefinition
  
  Returns the name assigned to the schema object.
  
  Overrides:
  
  getName in class SchemaObjectDefinition
  
  Returns:
  
  the name assigned to the schema object; name is never null.
- getExpression
  
  public String getExpression()
- getFromClause
  
  public String getFromClause()
- getIndexType
  
  public IndexType getIndexType()
- getOrder
  
  public int getOrder()
  
  Get the order value of this object.
  Returns:
  
  the order value of this object.
  
  See Also:
  
  Ordered
- getType
  
  public SchemaObjectType getType()
  
  Description copied from class: SchemaObjectDefinition
  
  Returns the type of schema object defined by this SchemaObjectDefinition.
  Specified by:
  
  getType in class SchemaObjectDefinition
  
  Returns:
  
  the type of schema object defined by this SchemaObjectDefinition.
  
  See Also:
  
  SchemaObjectType
- create
  
  public void create(GemfireAdminOperations gemfireAdminOperations)
  
  Description copied from class: SchemaObjectDefinition
  
  Creates an actual schema object from this SchemaObjectDefinition.
  Overrides:
  
  create in class SchemaObjectDefinition
  
  Parameters:
  
  gemfireAdminOperations - GemfireAdminOperations used to create an actual schema object from this SchemaObjectDefinition.
  
  See Also:
  
  GemfireAdminOperations
- as
  
  public IndexDefinition as(org.apache.geode.cache.query.IndexType gemfireGeodeIndexType)
- as
  
  public IndexDefinition as(IndexType indexType)
- having
  
  public IndexDefinition having(String expression)
- on
  
  public IndexDefinition on(org.apache.geode.cache.Region<?,?> region)
- on
  
  public IndexDefinition on(String fromClause)
- with
  
  public IndexDefinition with(String name)

Spring Data for VMware GemFire

Class IndexDefinition

Nested Class Summary

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.springframework.data.gemfire.config.schema.SchemaObjectDefinition

Methods inherited from class java.lang.Object

Field Details

ORDER

Constructor Details

IndexDefinition

Method Details

from

getIndex

getName

getExpression

getFromClause

getIndexType

getOrder

getType

create

as

as

having

on

on

with