org.apache.geode.cache.configuration

Class RegionConfig.Index

java.lang.Object

org.apache.geode.cache.configuration.CacheElement

org.apache.geode.cache.configuration.RegionConfig.Index

All Implemented Interfaces:

Serializable, Identifiable<String>, CorrespondWith<RuntimeInfo>, JsonSerializable, RestfulEndpoint

Enclosing class:

RegionConfig

public static class RegionConfig.Index
extends CacheElement
implements RestfulEndpoint, CorrespondWith<RuntimeInfo>

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice minOccurs="0">
         <element name="functional">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="expression" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="from-clause" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="imports" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="primary-key">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="field" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </choice>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="expression" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="from-clause" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="imports" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="key-index" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="type" default="range">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="range"/>
             <enumeration value="hash"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	expression
protected String	fromClause
protected String	imports
protected Boolean	keyIndex
protected String	name
protected String	regionName
protected String	type

Fields inherited from class org.apache.geode.cache.configuration.CacheElement

CLUSTER, groups

Fields inherited from interface org.apache.geode.management.api.RestfulEndpoint

URI_CONTEXT, URI_VERSION

Constructor Summary

Constructors

Constructor and Description
Index()
Index(RegionConfig.Index index)

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() this returns the URI that display the list of entries.
String	getExpression() Gets the value of the expression property.
String	getFromClause() Gets the value of the fromClause property.
String	getId() Gets the identifier uniquely identifying this Object instance.
String	getImports() Gets the value of the imports property.
String	getName() Gets the value of the name property.
String	getRegionName()
String	getType() Gets the value of the type property.
Boolean	isKeyIndex() Gets the value of the keyIndex property.
void	setExpression(String value) Sets the value of the expression property.
void	setFromClause(String value) Sets the value of the fromClause property.
void	setImports(String value) Sets the value of the imports property.
void	setKeyIndex(Boolean value) Sets the value of the keyIndex property.
void	setName(String value) Sets the value of the name property.
void	setRegionName(String regionName)
void	setType(String value) Deprecated. Index should only be a "key" or "range" type which is set using setKeyIndex(Boolean)

Methods inherited from class org.apache.geode.cache.configuration.CacheElement

addGroup, exists, findElement, getConfigGroup, getGroup, getGroups, removeElement, setGroup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.geode.management.api.RestfulEndpoint

getIdentityEndPoint, getUri

Methods inherited from interface org.apache.geode.management.api.CorrespondWith

getRuntimeClass, hasRuntimeInfo, isGlobalRuntime

Field Detail

name

protected String name

expression

protected String expression

fromClause

protected String fromClause

imports

protected String imports

keyIndex

protected Boolean keyIndex

type

protected String type

regionName

protected String regionName

Constructor Detail

Index

public Index()

Index

public Index(RegionConfig.Index index)

Method Detail

getName

public String getName()

Gets the value of the name property. possible object is String

setName

public void setName(String value)

Sets the value of the name property. allowed object is String

getExpression

public String getExpression()

Gets the value of the expression property. possible object is String

setExpression

public void setExpression(String value)

Sets the value of the expression property. allowed object is String

getFromClause

public String getFromClause()

Gets the value of the fromClause property. possible object is String

setFromClause

public void setFromClause(String value)

Sets the value of the fromClause property. allowed object is String

getImports

public String getImports()

Gets the value of the imports property. possible object is String

setImports

public void setImports(String value)

Sets the value of the imports property. allowed object is String

isKeyIndex

public Boolean isKeyIndex()

Gets the value of the keyIndex property. possible object is Boolean

setKeyIndex

public void setKeyIndex(Boolean value)

Sets the value of the keyIndex property. allowed object is Boolean

getType

public String getType()

Gets the value of the type property. possible object is String

setType

public void setType(String value)

Deprecated. Index should only be a "key" or "range" type which is set using setKeyIndex(Boolean)

Sets the value of the type property. Also sets the keyIndex property to true if the type being set is "key". allowed object is String

getRegionName

public String getRegionName()

setRegionName

public void setRegionName(String regionName)

getId

public String getId()

Description copied from interface: Identifiable

Gets the identifier uniquely identifying this Object instance.

Specified by:

getId in interface Identifiable<String>

Returns:

an identifier uniquely identifying this Object.

getEndpoint

public String getEndpoint()

Description copied from interface: RestfulEndpoint

this returns the URI that display the list of entries. it should return URI the part after /experimental

Specified by:

getEndpoint in interface RestfulEndpoint

Returns:

e.g. /regions