org.apache.geode.management.configuration

Class Index

java.lang.Object

org.apache.geode.management.configuration.AbstractConfiguration<R>

org.apache.geode.management.configuration.GroupableConfiguration<RuntimeInfo>

org.apache.geode.management.configuration.Index

All Implemented Interfaces:

Serializable, Identifiable<String>, JsonSerializable

public class Index
extends GroupableConfiguration<RuntimeInfo>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.geode.management.configuration.AbstractConfiguration

CLUSTER

Constructor Summary

Constructors

Constructor and Description
Index()

Method Summary

Modifier and Type	Method and Description
String	getExpression()
String	getId() Returns getName().
Boolean	getKeyIndex()
Links	getLinks() for internal usage only
String	getName()
String	getRegionName()
String	getRegionPath()
void	setExpression(String expression)
void	setKeyIndex(Boolean keyIndex)
void	setName(String name)
void	setRegionPath(String regionPath) the regionPath can be in any of these forms, e.g.: 1.

Methods inherited from class org.apache.geode.management.configuration.GroupableConfiguration

getGroup, setGroup

Methods inherited from class org.apache.geode.management.configuration.AbstractConfiguration

getGroupName, isCluster, isGlobalRuntime

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.lang.Identifiable

exists, find, remove

Constructor Detail

Index

public Index()

Method Detail

getName

public String getName()

setName

public void setName(String name)

getExpression

public String getExpression()

setExpression

public void setExpression(String expression)

getRegionPath

public String getRegionPath()

setRegionPath

public void setRegionPath(String regionPath)

the regionPath can be in any of these forms, e.g.: 1. regionName 2. /regionName 3. /regionName alias 4. /regionName.entrySet() 5. /regionName.fieldName.entrySet() alias

Note: only the regionName portion of the path is used when filtering.

getKeyIndex

public Boolean getKeyIndex()

setKeyIndex

public void setKeyIndex(Boolean keyIndex)

getRegionName

public String getRegionName()

Returns:

the regionName specified in the regionPath. Note this method assumes the regionName should not contain "."

getId

public String getId()

Returns getName().

Specified by:

getId in interface Identifiable<String>

Specified by:

getId in class AbstractConfiguration<RuntimeInfo>

Returns:

an identifier uniquely identifying this Object.

getLinks

public Links getLinks()

Description copied from class: AbstractConfiguration

for internal usage only

Specified by:

getLinks in class AbstractConfiguration<RuntimeInfo>