com.netrics.likeit

Class NetricsTableStats

java.lang.Object

com.netrics.likeit.NetricsTableStats

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NetricsDbStats

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

This class contains stats about a table in the Netrics server.

It can be used to get information about the size and structure of the table.

The tblload, tblmove, list, recget, recreplace, recupdate, recdelete, and recadd methods all return a NetricsTableStats object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetricsTableStats()
NetricsTableStats(NetricsLpar lpar, java.lang.String s)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getCharMaps() Return the name of the character map for each field of the table.
java.lang.String	getCheckpointStatus() Return the status of any checkpoint for this table.
int[]	getFieldBytes()
int[]	getFieldChars()
java.lang.String[]	getFieldNames() Return the names of the fields of the table.
int[]	getFieldTypes() Return the types of the fields of the table.
int	getHeaderBytes() Return the total size of the overhead for a table (in kbytes).
int	getIdxBytes() Return the total size of the indexing information for the table (in kbytes).
int	getKeyTreeBytes() Return the total size of the tree structure which holds the record keys for the table (in kbytes).
java.lang.String	getName() Return the name of the table.
int	getNumRecs() Return the number of records currently in the table.
int	getPhoneticGipBytes() Return the total size of the indexing information for the table for the "phoneticized records" (in kbytes).
int	getProcBytes() Return the total memory used by the process (in kbytes).
int	getRecFieldBytes() Return the total size of the overhead for storing the field structure of the table (in kbytes).
java.lang.String	getTblInfo() Return the table info field for this table.
int	getTotalBytes() Return the total size of the table, all structures included (in kbytes).
boolean	isGipFiltered() Return whether or not the GIP filter is turned on for the table.
boolean	isPhonetic() Return whether of not phonetics is turned on for the databse.
boolean	isPsiFiltered() Return whether or not the PSI filter is turned on for the table.
boolean	isSortFiltered() Return whether or not the SORT filter is turned on for the table.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NetricsTableStats

public NetricsTableStats(NetricsLpar lpar,
                 java.lang.String s)

NetricsTableStats

public NetricsTableStats()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Return the name of the table.

getTblInfo

public java.lang.String getTblInfo()

Return the table info field for this table. It will be null if no table info was specified at load time.

getCheckpointStatus

public java.lang.String getCheckpointStatus()

Return the status of any checkpoint for this table. This returns a description of the checkpoint status for a file. The possible return values are:

Last Checkpoint: yyyy/mm/dd-HH:MM:SS if the table was checkpointed
Never Checkpointed if the table is not checkpointed
Checkpoints Disabled if checkpointing is not enabled on this server
No Checkpoint Info if there was an error

getFieldNames

public java.lang.String[] getFieldNames()

Return the names of the fields of the table. This should be the same array of field names that was specified at load time.

getCharMaps

public java.lang.String[] getCharMaps()

Return the name of the character map for each field of the table.

getFieldTypes

public int[] getFieldTypes()

Return the types of the fields of the table. This is the same array of field types that was specified at load time.

getNumRecs

public int getNumRecs()

Return the number of records currently in the table.

getKeyTreeBytes

public int getKeyTreeBytes()

Return the total size of the tree structure which holds the record keys for the table (in kbytes).

getRecFieldBytes

public int getRecFieldBytes()

Return the total size of the overhead for storing the field structure of the table (in kbytes).

getHeaderBytes

public int getHeaderBytes()

Return the total size of the overhead for a table (in kbytes).

getFieldBytes

public int[] getFieldBytes()

Returns:

The total number of bytes in each field.

getFieldChars

public int[] getFieldChars()

Returns:

The total number of characters in each field.

isGipFiltered

public boolean isGipFiltered()

Return whether or not the GIP filter is turned on for the table. The GIP filter is a search accelerator for large tables. If the server does not have GIP enabled this will always be false.

isSortFiltered

public boolean isSortFiltered()

Return whether or not the SORT filter is turned on for the table. The SORT filter is a search accelerator for large tables. If the server does not have SORT enabled this will always be false.

isPsiFiltered

public boolean isPsiFiltered()

Return whether or not the PSI filter is turned on for the table. The PSI filter is a search accelerator for large tables. If the server does not have PSI enabled this will always be false.

getIdxBytes

public int getIdxBytes()

Return the total size of the indexing information for the table (in kbytes). This includes the indexes for the search accelerator filters (GIP or SORT) and any predicate indexes.

isPhonetic

public boolean isPhonetic()

Return whether of not phonetics is turned on for the databse. Currently phonetics is not supported and this is always false.

getPhoneticGipBytes

public int getPhoneticGipBytes()

Return the total size of the indexing information for the table for the "phoneticized records" (in kbytes). Currently phonetics is not supported and this is always zero.

getTotalBytes

public int getTotalBytes()

Return the total size of the table, all structures included (in kbytes). This is roughly the sum of the other statistics.

getProcBytes

public int getProcBytes()

Return the total memory used by the process (in kbytes). This is roughly the sum of the memory use of each table. Available only on LINUX platforms. If the server resides on any other platform this value is -1.