com.netrics.likeit

Class NetricsIdxStats

java.lang.Object

com.netrics.likeit.NetricsIdxStats

All Implemented Interfaces:

java.io.Serializable

public class NetricsIdxStats
extends java.lang.Object
implements java.io.Serializable

This class contains information about a partitioned index in the Netrics server.

It can be used to get information about the indexes for a table or set of tables. These objects are created and returned by the NetricsServerInterface idxlist method. Normally there is no need to explicitly create a NetricsIdxStats object.

See Also:

NetricsServerInterface.idxlist(java.lang.String[]), Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetricsIdxStats() Default constructor.
NetricsIdxStats(NetricsLpar lpar) Create a NetricsIdxStats object from the returned LPAR.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	Field() Return the field that is being indexed.
int	GipKBytes() Return the amount of memory in Kilo-Bytes used by the associated GIP indexes.
int	IdxKBytes() Return the index memory usage in Kilo-Bytes.
java.lang.String	IdxType() Return the index type as a string name.
boolean	isPrimary() Return true if this is a primary index.
boolean	normalized() Return true if this indexes normalized values.
int	NumberPartitions() Return the number of partitions in this index.
NetricsLpar	StatsLpar() Return the raw stats LPAR
java.lang.String	TableName() Return the name of the table the index is associated with.
java.lang.String	toString() Convert to string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetricsIdxStats

public NetricsIdxStats(NetricsLpar lpar)

Create a NetricsIdxStats object from the returned LPAR. This builds an initialized index stats object from the raw LPAR returned by the server as the result of an idxlist command. If the LPAR is not valid the string value of this object will be: "<None>: No Indexes", the table name is "None" and all other values are null. If a table has no indexes the stats object will have the string value: "Table-name: No Indexes" and all values except the table name will be null.

Parameters:

lpar - The raw status lpar.

See Also:

NetricsServerInterface.idxlist(java.lang.String[])

NetricsIdxStats

public NetricsIdxStats()

Default constructor.

Method Detail

toString

public java.lang.String toString()

Convert to string representation. Returns a formatted string representation of the index information.

Overrides:

toString in class java.lang.Object

StatsLpar

public NetricsLpar StatsLpar()

Return the raw stats LPAR

TableName

public java.lang.String TableName()

Return the name of the table the index is associated with.

Field

public java.lang.String Field()

Return the field that is being indexed.

IdxType

public java.lang.String IdxType()

Return the index type as a string name.

Returns:

"Primary" if a primary index, "Secondary" if a secondary index, "Unknown" otherwise.

isPrimary

public boolean isPrimary()

Return true if this is a primary index.

normalized

public boolean normalized()

Return true if this indexes normalized values.

NumberPartitions

public int NumberPartitions()

Return the number of partitions in this index.

IdxKBytes

public int IdxKBytes()

Return the index memory usage in Kilo-Bytes.

GipKBytes

public int GipKBytes()

Return the amount of memory in Kilo-Bytes used by the associated GIP indexes.