com.netrics.likeit

Class NetricsServerInterface

java.lang.Object

com.netrics.likeit.NetricsServerInterface

public class NetricsServerInterface
extends java.lang.Object

This is the main class of the Netrics Java Server Interface. It is the only class which communicates with the Netrics Server. It can be used to perform any Netrics command, such as querying, creating, or deleting Netrics tables, adding records to tables, etc.

See the Overview for an example of how to use this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ConnectionPoolingCommon Use a pool shared with other NetricsServerInterface objects.
static int	ConnectionPoolingLocal Use a separate pool for this NetricsServerInterface object.
static int	ConnectionPoolingNone Do not use connection pooling.

Constructor Summary

Constructors

Constructor and Description
NetricsServerInterface(java.lang.String host, int port) Create an object for interacting with a Netrics Server.
NetricsServerInterface(java.lang.String host, int port, boolean debug) Create an object for interacting with a Netrics Server.
NetricsServerInterface(java.lang.String host, int port, boolean debug, boolean log4j) Create an object for interacting with a Netrics Server.

Method Summary

Methods

Modifier and Type	Method and Description
NetricsTableStats	addRecsFromFile(java.lang.String tblname, boolean replaceNotAdd, NetricsLock lock, NetricsRecFile fileDef) Add or replace records from a file.
NetricsTableStats	addRecsFromFile(java.lang.String tblName, java.lang.String encoding, java.lang.String fileName, boolean doMaxWork, int[] fieldLengths, boolean leadingKey, int initialKey, boolean fieldNamesFirst, boolean replaceNotAdd) Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)
NetricsTableStats	addRecsFromFile(java.lang.String tblName, java.lang.String encoding, java.lang.String fileName, boolean doMaxWork, int[] fieldLengths, boolean leadingKey, int initialKey, boolean fieldNamesFirst, boolean fieldTypesFirst, boolean replaceNotAdd, NetricsLock lock) Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)
NetricsTableStats	addRecsFromFile(java.lang.String tblName, java.lang.String encoding, java.lang.String fileName, boolean doMaxWork, int[] fieldLengths, boolean leadingKey, int initialKey, boolean fieldNamesFirst, boolean replaceNotAdd, NetricsLock lock) Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)
java.lang.String[]	checkpoint(java.lang.String[] tblnames) Checkpoint tables currenntly loaded in the Netrics Server.
void	cmapcreate(NetricsCharmap cmap) Create a character map in the remote server.
java.lang.String[]	cmaplist() Lists the character maps currently loaded in the Netrics Engine.
void	cmdstats_reset(java.lang.String[] cmd_names, double start_time) Reset processing statistics for the specified commands.
NetricsCmdStats[]	cmdstats(java.lang.String[] cmd_names) Retrieve processing statistics for commands.
NetricsCmdStats[]	cmdstats(java.lang.String[] cmd_names, double duration) Retrieve processing statistics for specified duration for commands.
NetricsCmdStats[]	cmdstats(java.lang.String[] cmd_names, double duration, double end_time) Retrieve processing statistics for specified time period.
void	cthcreate(NetricsCombinedThesaurus cthes) Create a combined thesaurus in the remote server.
void	dbdelete(java.lang.String tblName) Deprecated. use tbldelete(String)
NetricsDb	dbdump(java.lang.String tblName) Deprecated. use tbldump(String)
NetricsDb	dbdump(java.lang.String tblName, NetricsLock lock) Deprecated. use tbldump(String,NetricsLock)
NetricsDbStats[]	dblist(java.lang.String[] tblnames) Deprecated. use list(String[])
NetricsDbStats	dbload(NetricsDb tbl) Deprecated. Use tblload(NetricsTable)
void	dblock(java.lang.String tblName) Deprecated. use tbllock(String)
NetricsLock	dblock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed) Deprecated. use tbllock(String,boolean,boolean,boolean,boolean)
NetricsLock	dblock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed, NetricsLock lock) Deprecated. use tbllock(String,boolean,boolean,boolean,boolean,NetricsLock)
void	dbmove(java.lang.String oldName, java.lang.String newName) This method is provided for reverse compatibilty.
NetricsDbStats	dbrecadd(java.lang.String tblName, NetricsRecord rec) Deprecated. use recadd(String,NetricsRecord)
NetricsDbStats	dbrecadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork) Deprecated. use recadd(String,NetricsRecSrc,boolean)
NetricsDbStats	dbrecadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock) Deprecated. use recadd(String,NetricsRecSrc,boolean,NetricsLock,int)
NetricsDbStats	dbrecdelete(java.lang.String tblName, java.lang.String recKey) Deprecated. use recdelete(String,String)
NetricsDbStats	dbrecdelete(java.lang.String tblName, java.lang.String[] recKeys, boolean doMaxWork) Deprecated. use recdelete(String,String[],boolean)
NetricsDbStats	dbrecdelete(java.lang.String tblName, java.lang.String[] recKeys, boolean doMaxWork, NetricsLock lock) Deprecated. use recdelete(String,String[],boolean,NetricsLock)
NetricsRecord	dbrecget(java.lang.String tblName, java.lang.String recKey) Deprecated. use recget(String,String)
NetricsRecord[]	dbrecget(java.lang.String tblName, java.lang.String[] recKeys) Deprecated. use recget(String,String[])
NetricsRecord[]	dbrecget(java.lang.String tblName, java.lang.String[] recKeys, NetricsLock lock) Deprecated. use recget(String,String[],NetricsLock)
NetricsDbStats	dbrecreplace(java.lang.String tblName, NetricsRecord rec) Deprecated. use recreplace(String,NetricsRecord)
NetricsDbStats	dbrecreplace(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork) Deprecated. use recreplace(String,NetricsRecSrc,boolean)
NetricsDbStats	dbrecreplace(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock) Deprecated. use recreplace(String,NetricsRecSrc,boolean,NetricsLock)
NetricsSearchResponse	dbsearch(NetricsDbSearchCfg[] tblCfgs, NetricsSearchOpts opts) Deprecated. use search(NetricsSearchCfg[],NetricsSearchOpts)
NetricsSearchResponse	dbsearch(NetricsDbSearchCfg tblCfg, NetricsSearchOpts opts) Deprecated. use search(NetricsSearchCfg,NetricsSearchOpts)
void	dbunlock(java.lang.String tblName) Deprecated. use tblunlock(String)
void	dbunlock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed) Deprecated. use tblunlock(String,boolean,boolean,boolean,boolean)
void	dbunlock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed, NetricsLock lock) Deprecated. use tblunlock(String,boolean,boolean,boolean,boolean,NetricsLock)
boolean	DebuggingOff() Turn off debugging output.
boolean	DebuggingOn() Turn on debugging output.
int	getConnectionPoolingPolicy() Retrieve the connection pooling policy currently in use.
NetricsIdxStats[]	idxlist(java.lang.String[] tblnames) Lists statistics for partitioned indexes.
boolean	isDecisionEngine() Return true if the server indicates it is a Decision Engine.
boolean	isGIPEnabled() Return true if the server indicates the GIP prefilter is enabled.
boolean	isPsiEnabled() Return true if the server indicates the Psi prefilter is enabled.
boolean	isSortEnabled() Return true if the server indicates the Sort prefilter is enabled.
NetricsTableStats[]	list(java.lang.String[] tblnames) Lists statistics for tables currenntly loaded in the Netrics Server.
NetricsTableStats	recadd(java.lang.String tblName, NetricsRecord rec) Add a single record to a table.
NetricsTableStats	recadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork) A version of recadd which does not require a lock key or est records.
NetricsTableStats	recadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, int estNumRecs) A version of recadd which does not require a lock key.
NetricsTableStats	recadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock) recadd with no estimated record count.
NetricsTableStats	recadd(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock, int estNumRecs) Add multiple records to a table.
NetricsTableStats	recdelete(java.lang.String tblName, java.lang.String recKey) Delete a single record from a table.
NetricsTableStats	recdelete(java.lang.String tblName, java.lang.String[] recKeys, boolean doMaxWork) A version of recdelete which does not require a lock key.
NetricsTableStats	recdelete(java.lang.String tblName, java.lang.String[] recKeys, boolean doMaxWork, NetricsLock lock) Delete multiple records from a table.
NetricsRecord	recget(java.lang.String tblName, java.lang.String recKey) Get a single record from a table.
NetricsRecord[]	recget(java.lang.String tblName, java.lang.String[] recKeys) A version of recget which does not require a lock key.
NetricsRecord[]	recget(java.lang.String tblName, java.lang.String[] recKeys, NetricsLock lock) Get multiple records from a table.
NetricsTableStats	recreplace(java.lang.String tblName, NetricsRecord rec) Replace a single existing record in a table.
NetricsTableStats	recreplace(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork) A version of recreplace which does not require a lock key.
NetricsTableStats	recreplace(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock) Replace a set of records in a table.
NetricsTableStats	recupdate(java.lang.String tblName, NetricsRecord rec) Update a single existing record in a table.
NetricsTableStats	recupdate(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork) A version of recupdate which does not require a lock key.
NetricsTableStats	recupdate(java.lang.String tblName, NetricsRecSrc src, boolean doMaxWork, NetricsLock lock) Update a set of records in a table.
java.lang.String[]	restore(java.lang.String[] tblnames) Restore tables previously checkpointed.
void	rlcreate(java.lang.String rlModelName, java.lang.String rlModelFile) Use this function to load a Netrics Decision Engine model under the given name.
void	rldelete(java.lang.String[] modellist) Delete one or more Netrics Decision Engine Models.
double	rleval(java.lang.String rlModelName, double[] featurevec) Evaluate a Netrics Decision Engine model with the given vector of feature values.
NetricsModelStats[]	rllist(java.lang.String[] modellist) List information on Netrics Decision Engine models.
NetricsSearchResponse	search(NetricsSearchCfg[] tblCfgs, NetricsSearchOpts opts) Perform a search on one or more tables.
NetricsSearchResponse	search(NetricsSearchCfg tblCfg, NetricsSearchOpts opts) Perform a search on a single table.
void	selectLayout(java.lang.String layout) Set the current cluster layout.
NetricsServerStats	server_info() Retrieve the server version information.
void	setCharset(java.lang.String charset) Do not change this unless instructed to do so by your TIBCO representative.
void	setConnectionPoolingPolicy(int policy) Set the connection pooling policy for this object.
java.util.Locale	setServerLocale(java.util.Locale locale) Sets the locale used by the interface when formatting exchanges with the server.
void	svrlogoff() Turn off search logging (must be enabled when the server starts up).
void	svrlogon() Turn on search logging.
void	svrnoop() Perform a noop on the Netrics Server.
void	svrshutdown() Shutdown the Netrics Server.
java.lang.String	svrversion() Retrieve the version information of this interface.
void	tbldelete(java.lang.String tblName) Delete a table.
NetricsTable	tbldump(java.lang.String tblName) Version of tbldump which does not require a lock key.
NetricsTable	tbldump(java.lang.String tblName, NetricsLock lock) Dump the records of the specified table.
NetricsTableStats	tblload(NetricsTable tbl) Used to load a NetricsTable into the server.
NetricsTableStats	tblload(NetricsTable tbl, boolean doMaxWork) Used to load a NetricsTable into the server.
NetricsTableStats	tblload(NetricsTable tbl, NetricsRecFile fileDef) Create and load a table from a server side CSV file.
void	tbllock(java.lang.String tblName) For compatibility with older versions.
NetricsLock	tbllock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed) Version of tbllock which does not require a NetricsLock object.
NetricsLock	tbllock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed, NetricsLock lock) These commands block and unblock operations on a table.
void	tblmove(java.lang.String oldName, java.lang.String newName) Rename a table.
void	tblunlock(java.lang.String tblName) For compatibility with 3.2.
void	tblunlock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed) Version of tblunlock which does not require a NetricsLock object.
void	tblunlock(java.lang.String tblName, boolean searchesOnly, boolean recursive, boolean exclusive, boolean keyed, NetricsLock lock) Unlock a locked table.
void	thcreate(NetricsThesaurus thes) Create a thesaurus in the remote server.
void	thdelete(java.lang.String[] theslist) Delete one or more thesauri currently loaded on the server.
NetricsThesStats[]	thes_stats(java.lang.String[] thes_names) Lists statistics on thesauri currently loaded on the server.
java.lang.String[]	thlist() Lists the thesauri currently loaded in the Netrics Server.
NetricsTableStats	updRecsFromFile(java.lang.String tblname, NetricsLock lock, NetricsRecFile fileDef) Update records from a file.
java.lang.String	version() Retreive the Netrics Server Interface version information.
void	wdcreate(NetricsWeightedDictionary wdict) Create a weighted dictionary in the remote server.

Methods inherited from class java.lang.Object

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

Field Detail

ConnectionPoolingNone

public static final int ConnectionPoolingNone

Do not use connection pooling.

See Also:

Constant Field Values

ConnectionPoolingLocal

public static final int ConnectionPoolingLocal

Use a separate pool for this NetricsServerInterface object.

See Also:

Constant Field Values

ConnectionPoolingCommon

public static final int ConnectionPoolingCommon

Use a pool shared with other NetricsServerInterface objects.

See Also:

Constant Field Values

Constructor Detail

NetricsServerInterface

public NetricsServerInterface(java.lang.String host,
                      int port)

Create an object for interacting with a Netrics Server.

Parameters:

host - The hostname or IP address of the machine on which the Netrics Server is running.

port - The port number which the Netrics Server is listening on

NetricsServerInterface

public NetricsServerInterface(java.lang.String host,
                      int port,
                      boolean debug)

Create an object for interacting with a Netrics Server.

Parameters:

host - The hostname or IP address of the machine on which the Netrics Server is running.

port - The port number which the Netrics Server is listening on

debug - If true output to stderr detailed information on all interactions with the server.

NetricsServerInterface

public NetricsServerInterface(java.lang.String host,
                      int port,
                      boolean debug,
                      boolean log4j)

Create an object for interacting with a Netrics Server.

Parameters:

host - The hostname or IP address of the machine on which the Netrics Server is running.

port - The port number which the Netrics Server is listening on

debug - If true output detailed information on all interactions with the server.

log4j - Dump output to log4j logger.

Method Detail

DebuggingOn

public boolean DebuggingOn()

Turn on debugging output.

Turn on very verbose debugging output. This should only be used on the advice of TIBCO support.

Returns:

the previous debugging state.

DebuggingOff

public boolean DebuggingOff()

Turn off debugging output.

Turn off debugging output. This should only be used on the advice of TIBCO support.

Returns:

the previous debugging state.

selectLayout

public void selectLayout(java.lang.String layout)

Set the current cluster layout. The default is null.

getConnectionPoolingPolicy

public int getConnectionPoolingPolicy()

Retrieve the connection pooling policy currently in use.

setConnectionPoolingPolicy

public void setConnectionPoolingPolicy(int policy)
                                throws NetricsException

Set the connection pooling policy for this object. The default policy is: ConnectionPoolingCommon. This should be changed only on the advice of your TIBCO representative.

Throws:

NetricsException

setCharset

public void setCharset(java.lang.String charset)

Do not change this unless instructed to do so by your TIBCO representative.

dbload

public NetricsDbStats dbload(NetricsDb tbl)
                      throws java.io.IOException,
                             NetricsException

Deprecated. Use tblload(NetricsTable)

Throws:

java.io.IOException

NetricsException

tblload

public NetricsTableStats tblload(NetricsTable tbl)
                          throws java.io.IOException,
                                 NetricsException

Used to load a NetricsTable into the server.

Parameters:

tbl - The table to be loaded

Returns:

The statistics for the table just loaded

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLEXISTS, TBLPARAM, RECEXISTS, CHARMAP, DUPFIELDNAMES, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FEATURESET, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, PARAMCONFLICT, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTable

tblload

public NetricsTableStats tblload(NetricsTable tbl,
                        boolean doMaxWork)
                          throws java.io.IOException,
                                 NetricsException

Used to load a NetricsTable into the server.

Parameters:

tbl - The table to be loaded

doMaxWork - process as many records as possible, ignoring those with errors.

Returns:

The statistics for the table just loaded

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLEXISTS, TBLPARAM, RECEXISTS, CHARMAP, DUPFIELDNAMES, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FEATURESET, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, PARAMCONFLICT, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTable

tblload

public NetricsTableStats tblload(NetricsTable tbl,
                        NetricsRecFile fileDef)
                          throws NetricsException,
                                 java.io.IOException

Create and load a table from a server side CSV file.

Parameters:

tbl - Defines table to be loaded. Record source is ignored.

fileDef - Defines the name and format of the file containing the records.

Returns:

The statistics for the table just created

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLEXISTS, TBLPARAM, RECEXISTS, CHARMAP, DUPFIELDNAMES, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FEATURESET, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, PARAMCONFLICT, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTable, NetricsRecFile

addRecsFromFile

public NetricsTableStats addRecsFromFile(java.lang.String tblname,
                                boolean replaceNotAdd,
                                NetricsLock lock,
                                NetricsRecFile fileDef)
                                  throws NetricsException,
                                         java.io.IOException

Add or replace records from a file.

Parameters:

tblname - Defines table to be loaded.

replaceNotAdd - if true this replaces existing records, if false it adds new records.

lock - A lock key for the table. May be null.

fileDef - Defines the name and format of the file containing the records.

Returns:

The statistics for the table just created

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLEXISTS, TBLPARAM, RECEXISTS, CHARMAP, DUPFIELDNAMES, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FEATURESET, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, PARAMCONFLICT, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsRecFile

updRecsFromFile

public NetricsTableStats updRecsFromFile(java.lang.String tblname,
                                NetricsLock lock,
                                NetricsRecFile fileDef)
                                  throws NetricsException,
                                         java.io.IOException

Update records from a file.

This will add the given records if the do not already exist, or replace them if they do exist.

Parameters:

tblname - Defines table to be loaded.

lock - A lock key for the table. May be null.

fileDef - Defines the name and format of the file containing the records.

Returns:

The statistics for the table as it exists at the completion of the update.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLEXISTS, TBLPARAM, RECEXISTS, CHARMAP, DUPFIELDNAMES, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FEATURESET, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, PARAMCONFLICT, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsRecFile

addRecsFromFile

public NetricsTableStats addRecsFromFile(java.lang.String tblName,
                                java.lang.String encoding,
                                java.lang.String fileName,
                                boolean doMaxWork,
                                int[] fieldLengths,
                                boolean leadingKey,
                                int initialKey,
                                boolean fieldNamesFirst,
                                boolean fieldTypesFirst,
                                boolean replaceNotAdd,
                                NetricsLock lock)
                                  throws NetricsException,
                                         java.io.IOException

Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)

Throws:

NetricsException

java.io.IOException

addRecsFromFile

public NetricsTableStats addRecsFromFile(java.lang.String tblName,
                                java.lang.String encoding,
                                java.lang.String fileName,
                                boolean doMaxWork,
                                int[] fieldLengths,
                                boolean leadingKey,
                                int initialKey,
                                boolean fieldNamesFirst,
                                boolean replaceNotAdd)
                                  throws NetricsException,
                                         java.io.IOException

Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)

Throws:

NetricsException

java.io.IOException

addRecsFromFile

public NetricsTableStats addRecsFromFile(java.lang.String tblName,
                                java.lang.String encoding,
                                java.lang.String fileName,
                                boolean doMaxWork,
                                int[] fieldLengths,
                                boolean leadingKey,
                                int initialKey,
                                boolean fieldNamesFirst,
                                boolean replaceNotAdd,
                                NetricsLock lock)
                                  throws NetricsException,
                                         java.io.IOException

Deprecated. As of release 4.4.3. Use addRecsFromFile(String,boolean,NetricsLock,NetricsRecFile)

Throws:

NetricsException

java.io.IOException

thcreate

public void thcreate(NetricsThesaurus thes)
              throws java.io.IOException,
                     NetricsException

Create a thesaurus in the remote server.

Parameters:

thes - The NetricsThesaurus object to create on the remote server. The name and synonyms of the thesaurus are defined by using the thesaurus object's methods.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, CHARMAP, EXPECTTHESNAME, EXPECTLIST, FEATURESET, IOERROR, PARAMVAL, PARAMMISSING)

java.io.IOException

cthcreate

public void cthcreate(NetricsCombinedThesaurus cthes)
               throws java.io.IOException,
                      NetricsException

Create a combined thesaurus in the remote server.

Parameters:

cthes - The NetricsCombinedThesaurus object to create on the remote server. The name and synonyms of the thesaurus are defined by using the thesaurus object's methods.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, CHARMAP, EXPECTTHESNAME, EXPECTLIST, FEATURESET, IOERROR, PARAMVAL, PARAMMISSING)

java.io.IOException

cmapcreate

public void cmapcreate(NetricsCharmap cmap)
                throws java.io.IOException,
                       NetricsException

Create a character map in the remote server.

Parameters:

cmap - The character map to add.

Throws:

java.io.IOException

NetricsException

wdcreate

public void wdcreate(NetricsWeightedDictionary wdict)
              throws java.io.IOException,
                     NetricsException

Create a weighted dictionary in the remote server.

Parameters:

wdict - The NetricsWeightedDictionary object to create on the remote server. The name and synonyms of the thesaurus are defined by using the thesaurus object's methods.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, CHARMAP, EXPECTTHESNAME, EXPECTLIST, FEATURESET, IOERROR, PARAMVAL, PARAMMISSING)

java.io.IOException

rlcreate

public void rlcreate(java.lang.String rlModelName,
            java.lang.String rlModelFile)
              throws java.io.IOException,
                     NetricsException

Use this function to load a Netrics Decision Engine model under the given name. When using a model, you must configure the search query appropriately See setRlModelName for more information.

Parameters:

rlModelName - The name the model will be loaded under.

rlModelFile - The location of the model file on disk. The model will be provided to you by your Netrics representative.

Throws:

java.io.IOException

NetricsException

See Also:

NetricsSearchOpts.setRlModelName(java.lang.String)

rllist

public NetricsModelStats[] rllist(java.lang.String[] modellist)
                           throws java.io.IOException,
                                  NetricsException

List information on Netrics Decision Engine models.

This lists basic information on one or more Netrics Decision Engine Models currently loaded on the Netrics server.

If any of the model names given are not on the engine a NetricsException error is thrown with a code of RLINKMODELNOTFOUND.

Parameters:

modellist - The names of the models to be listed. Pass null to list all models on the server.

Returns:

An array of NetricsModelStats objects.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - NODBDESC, RLINKMODELNOTFOUND, EXPECTLIST, FEATURESET, PARAMVAL, INTERNAL, NOSYSINIT)

java.io.IOException - If an I/O error occurs

See Also:

NetricsModelStats

rldelete

public void rldelete(java.lang.String[] modellist)
              throws java.io.IOException,
                     NetricsException

Delete one or more Netrics Decision Engine Models.

This deletes or more Netrics Decision Engine Models currently loaded on the Netrics server.

If any of the model names given are not on the engine a NetricsException error is thrown with a code of RLINKMODELNOTFOUND, however all other models will still be deleted.

Parameters:

modellist - The names of the models to be deleted. Pass null to delete all models on the server.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - NODBDESC, RLINKMODELNOTFOUND, EXPECTLIST, FEATURESET, PARAMVAL, INTERNAL, NOSYSINIT)

java.io.IOException - If an I/O error occurs

rleval

public double rleval(java.lang.String rlModelName,
            double[] featurevec)
              throws java.io.IOException,
                     NetricsException

Evaluate a Netrics Decision Engine model with the given vector of feature values.

Parameters:

rlModelName - The name of the model to use in the evaluation.

featurevec - An array of double feature values (from 0.0 to 1.0) which will be evaluated by the model. The number of features in this array must be the same as the model was created and trained with.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - NORLINKMODEL, RLINKMODELNOTFOUND, NOFEATUREVEC, NUMFEATURESMISMATCH, FEATURESET, IOERROR, PARAMVAL)

java.io.IOException

dbsearch

public NetricsSearchResponse dbsearch(NetricsDbSearchCfg tblCfg,
                             NetricsSearchOpts opts)
                               throws java.io.IOException,
                                      NetricsException

Deprecated. use search(NetricsSearchCfg,NetricsSearchOpts)

Throws:

java.io.IOException

NetricsException

search

public NetricsSearchResponse search(NetricsSearchCfg tblCfg,
                           NetricsSearchOpts opts)
                             throws java.io.IOException,
                                    NetricsException

Perform a search on a single table.

Throws:

java.io.IOException

NetricsException

See Also:

search(NetricsSearchCfg[],NetricsSearchOpts)

dbsearch

public NetricsSearchResponse dbsearch(NetricsDbSearchCfg[] tblCfgs,
                             NetricsSearchOpts opts)
                               throws java.io.IOException,
                                      NetricsException

Deprecated. use search(NetricsSearchCfg[],NetricsSearchOpts)

Throws:

java.io.IOException

NetricsException

search

public NetricsSearchResponse search(NetricsSearchCfg[] tblCfgs,
                           NetricsSearchOpts opts)
                             throws java.io.IOException,
                                    NetricsException

Perform a search on one or more tables.

Queries are set in the NetricsSearchCfg objects and overall search options are set in the NetricsSearchOpts object

Parameters:

tblCfgs - One NetricsSearchCfg per table which will be searched (can be specified in any order)

opts - The configuration object for the overall search - allows a number of options for searching

Returns:

A NetricsSearchResponse object containing the results of the search

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLLOCKED, TBLNOTFOUND, EXPECTTBLDESC, EXPECTRTBLDESC, EXPECTLIST, EXPECTQUERY, FEATUREOFF, FEATURESET, LISTLEN, LOOKUP, NOTBLDESC, NOQUERY, NSFIELD, NUMFIELDS, PARAMCONFLICT, PARAMMISSING, PARAMVAL, PARTIAL, PREDTYPE, SRCHPARAM, THESNOTFOUND, UNKFIELD)

java.io.IOException - If an I/O error occurs

See Also:

NetricsSearchCfg, NetricsSearchOpts

dblist

public NetricsDbStats[] dblist(java.lang.String[] tblnames)
                        throws java.io.IOException,
                               NetricsException

Deprecated. use list(String[])

Throws:

java.io.IOException

NetricsException

list

public NetricsTableStats[] list(java.lang.String[] tblnames)
                         throws java.io.IOException,
                                NetricsException

Lists statistics for tables currenntly loaded in the Netrics Server.

Parameters:

tblnames - The names of the tables for which to recieve statistics. Pass null to recieve a NetricsTableStats object for every table currently loaded

Returns:

An array of NetricsTableStats objects, one per requested table

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLNOTFOUND, EXPECTTBLDESC, EXPECTLIST, FEATURESET, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

checkpoint

public java.lang.String[] checkpoint(java.lang.String[] tblnames)
                              throws java.io.IOException,
                                     NetricsException

Checkpoint tables currenntly loaded in the Netrics Server.

Checkpointing a table allows the table to be restored to the state it was in at the time of the checkpoint. A checkpoint is made to a permanent file store, so checkpoints can be restored across different server invocations. A checkpoint restore is the fastest way to load a table.

In order to checkpoint a file the server must have been started with checkpointing enabled. See the server user's manual for information on how to enable checkpointing.

If one or more of the named tables do not exists a NetricsException is thrown with an error code of DBNOTFOUND. All tables that were found are checkpointed.

If some, but not all, of the tables fail to checkpoint for any other reason a NetricsException is thrown with error code PARTIALCHPT. Again some tables may have checkpointed successfully in this case.

If all tables fail to checkpoint correctly and not all of them failed because the named table didn't exist a NetricsException is thrown with error code CHPTFAILED.

The extended error item will be a generic list containing the DBDESCRIPTOR for each table that failed to checkpoint correctly for any reason.

Parameters:

tblnames - The names of the tables to be checkpointed. Pass null to checkpoint all tables currently in the server.

Returns:

An array of the names of the tables that were successfully checkpointed.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - DBPARAM, NODBDESC, EXPECTDBDESC, DUPDBDESCS, FEATURESET, DBNOTFOUND, PARTIALCHPT, CHPTFAILED, INTERNAL, NOSYSINIT)

java.io.IOException - If an I/O error occurs

restore

public java.lang.String[] restore(java.lang.String[] tblnames)
                           throws java.io.IOException,
                                  NetricsException

Restore tables previously checkpointed.

This restores a table to the state of the latest checkpoint for that table. The checkpoint could have been made from this invocation of the server, in which case this backs up the state of the table to that at the time of the last checkpoint, or in a previous invocation of the server, in which case this is a way to quickly reload a table.

In order to restore a file the server must have been started with checkpointing enabled. See the server user's manual for information on how to enable checkpointing.

If some, but not all, of the tables fail to restore a NetricsException is thrown with error code PARTIALRESTORE.

If all tables fail to restore correctly a NetricsException is thrown with error code RESTOREFAILED.

Parameters:

tblnames - The names of the tables to be restored. Pass null to restore all tables that were previously checkpointed.

Returns:

An array of the names of the tables that were successfully restored.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - DBPARAM, NODBDESC, EXPECTDBDESC, DUPDBDESCS, FEATURESET, PARTIALRESTORE, RESTOREFAILED, INTERNAL, NOSYSINIT, SHUTDOWN)

java.io.IOException - If an I/O error occurs

idxlist

public NetricsIdxStats[] idxlist(java.lang.String[] tblnames)
                          throws java.io.IOException,
                                 NetricsException

Lists statistics for partitioned indexes. This command can be used to retrieve information on all of the partition indexes associated with one or more tables loaded into the Netrics server. Information can be retrieved for all tables or a list of specific tables. Information for all indexes associated with the indicated tables is returned as a list of NetricsIdxStats objects. It is an error if a named table doesn't exist. If a table has no indexes an empty stats object is returned for that table.

Parameters:

tblnames - The names of the tables for which to recieve statistics. Pass null to recieve information for indexes of all tables.

Returns:

An array of NetricsIdxStats objects.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLNOTFOUND, EXPECTTBLDESC, EXPECTLIST, FEATURESET, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

See Also:

NetricsIdxStats

thdelete

public void thdelete(java.lang.String[] theslist)
              throws java.io.IOException,
                     NetricsException

Delete one or more thesauri currently loaded on the server.

This deletes all of the thesauri given (all thesauri on the server if null passed).

Parameters:

theslist - The names of the thesauri to be deleted. Pass null to delete all thesauri on the server.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - NODBDESC, THESNOTFOUND, EXPECTLIST, FEATURESET, PARAMVAL, INTERNAL, NOSYSINIT)

java.io.IOException - If an I/O error occurs

thlist

public java.lang.String[] thlist()
                          throws java.io.IOException,
                                 NetricsException

Lists the thesauri currently loaded in the Netrics Server.

Returns:

An array of Strings, one per thesaurus loaded in the Netrics Server.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - THESNOTFOUND, EXPECTLIST, PARAMVAL, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

thes_stats

public NetricsThesStats[] thes_stats(java.lang.String[] thes_names)
                              throws java.io.IOException,
                                     NetricsException

Lists statistics on thesauri currently loaded on the server.

Parameters:

thes_names - A list of the thesaurus names who's statistics should be returned. If null statistics on all thesauri is returned.

Returns:

An array of NetricsThesStats, one per thesaurus loaded in the Netrics Server.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - THESNOTFOUND, EXPECTLIST, PARAMVAL, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

See Also:

NetricsThesStats

cmaplist

public java.lang.String[] cmaplist()
                            throws java.io.IOException,
                                   NetricsException

Lists the character maps currently loaded in the Netrics Engine.

Returns:

An array of Strings, one per character map loaded in the Netrics Engine.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - THESNOTFOUND, EXPECTLIST, PARAMVAL, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

dbmove

public void dbmove(java.lang.String oldName,
          java.lang.String newName)
            throws java.io.IOException,
                   NetricsException

This method is provided for reverse compatibilty.

Throws:

java.io.IOException

NetricsException

tblmove

public void tblmove(java.lang.String oldName,
           java.lang.String newName)
             throws java.io.IOException,
                    NetricsException

Rename a table. Call this method to rename an existing table. Note that if the table with the name newName already exists, it will be deleted, and replaced by the table that you are renaming.

Parameters:

oldName - The name of the table that will be renamed

newName - The new name of the table

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLMOVESAME, TBLNOTFOUND, EXPECTTBLDESC, FEATURESET, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

dbdelete

public void dbdelete(java.lang.String tblName)
              throws java.io.IOException,
                     NetricsException

Deprecated. use tbldelete(String)

Throws:

java.io.IOException

NetricsException

tbldelete

public void tbldelete(java.lang.String tblName)
               throws java.io.IOException,
                      NetricsException

Delete a table. Call this method to delete an existing table.

Parameters:

tblName - The name of the table to be deleted

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLNOTFOUND, EXPECTTBLDESC, NOTBLDESC, NOSYSINIT)

java.io.IOException - If an I/O error occurs

dbdump

public NetricsDb dbdump(java.lang.String tblName,
               NetricsLock lock)
                 throws java.io.IOException,
                        NetricsException

Deprecated. use tbldump(String,NetricsLock)

Throws:

java.io.IOException

NetricsException

tbldump

public NetricsTable tbldump(java.lang.String tblName,
                   NetricsLock lock)
                     throws java.io.IOException,
                            NetricsException

Dump the records of the specified table.

The tables record's can be accessed through the NetricsTable's NetricsRecSrc object. The NetricsTable can be loaded into another server using the tblload command.

CAUTION! The entire contents of the table will be read into the memory space of the client. For large tables this is very likely to cause the Java Virtual Machine to run out of memory.

Note: This method will NOT delete the table.

Parameters:

tblName - The name of the table to dump

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

A NetricsTable object representing the table.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLLOCKED, TBLNOTFOUND, EXPECTTBLDESC, NOTBLDESC, PARAMVAL, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

tblload(com.netrics.likeit.NetricsTable)

dbdump

public NetricsDb dbdump(java.lang.String tblName)
                 throws java.io.IOException,
                        NetricsException

Deprecated. use tbldump(String)

Throws:

java.io.IOException

NetricsException

tbldump

public NetricsTable tbldump(java.lang.String tblName)
                     throws java.io.IOException,
                            NetricsException

Version of tbldump which does not require a lock key.

Throws:

java.io.IOException

NetricsException

dblock

public NetricsLock dblock(java.lang.String tblName,
                 boolean searchesOnly,
                 boolean recursive,
                 boolean exclusive,
                 boolean keyed,
                 NetricsLock lock)
                   throws java.io.IOException,
                          NetricsException

Deprecated. use tbllock(String,boolean,boolean,boolean,boolean,NetricsLock)

Throws:

java.io.IOException

NetricsException

tbllock

public NetricsLock tbllock(java.lang.String tblName,
                  boolean searchesOnly,
                  boolean recursive,
                  boolean exclusive,
                  boolean keyed,
                  NetricsLock lock)
                    throws java.io.IOException,
                           NetricsException

These commands block and unblock operations on a table. If a number of updating commands are to be run on a given table, these commands are useful for making sure that no lookups take place until the whole sequence of updates is complete. (Otherwise, it is possible that lookups or other operations could occur between update commands.)

Table locks have several optional properties which may be useful in different situations.

With no options, the tbllock command implements a simple toggle lock. Attempts to set or unset the lock always succeed, provided that no other types of locks are in use. A toggle lock only has two states, locked or unlocked. If you were to set the lock twice, and then unset it once, the table would be unlocked.

In contrast, a recursive lock is a counting lock. When locked with a recursive lock, the table will not become unlocked until the number of unlock operations match the number of lock operations. This kind of lock can be useful in environments with updates coming from multiple independent sources. Client A can set a recursive lock, and begin adding new records. Client B can also set a recursive lock and begin adding records. The table will not become unlocked until both clients A and B have released their locks. To create a recursive lock, pass the recursive parameter a value of true.

An exclusive lock is another type of lock which may be useful when updates are coming from multiple sources. Unlike a recursive lock, attempts to lock a locked table with an exclusive lock will return with an error. When using exclusive locks, client A may set an exclusive lock and begin adding new records. When client B attempts to acquire a lock, it will fail and need to wait and try again when client A has released the lock. To create an exclusive lock, pass the exclusive parameter a value of true.

Table locks may also be keyed. When the keyed parameter is set to true, a keyed lock will be created. It will be returned to the caller in the NetricsLock object. The use of the key in any NetricsServerInterface method will allow that method to succeed, even though the table is locked. When a keyed lock is used, the key must be used to unlock the table. Unlike an unkeyed lock, a keyed lock is allowed to be both recursive and exclusive.

Lock types may not be mixed on a single table at a single time. Attempts to acquire a lock on a locked table with differing locking options will always fail. Any locking options used in a lock command must also be used in a corresponding unlock command to ensure that the unlock operation matches the lock operation.

Parameters:

tblName - The name of the table to lock

searchesOnly - If this parameter is true, the lock blocks only searches, and all updates may proceed unaffected by the lock.

recursive - If this parameter is true, the lock is a counting lock.

exclusive - If this parameter is true, the lock will fail on a locked table unless the lock is also recursive and keyed.

keyed - If this parameter is true, a key will be generated which can be used to perform operations on tables even though they are locked.

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

A NetricsLock object which contains the keyed lock. It can be passed to other methods to operate on the locked table. Operations will only succeed if this lock object is specified.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - EXPECTTBLDESC, NOTBLDESC, TBLNOTFOUND, TBLLOCKED, TBLUNLOCKED, PARAMVAL)

java.io.IOException - If an I/O error occurs

See Also:

tblunlock(java.lang.String, boolean, boolean, boolean, boolean, com.netrics.likeit.NetricsLock)

dblock

public NetricsLock dblock(java.lang.String tblName,
                 boolean searchesOnly,
                 boolean recursive,
                 boolean exclusive,
                 boolean keyed)
                   throws java.io.IOException,
                          NetricsException

Deprecated. use tbllock(String,boolean,boolean,boolean,boolean)

Throws:

java.io.IOException

NetricsException

tbllock

public NetricsLock tbllock(java.lang.String tblName,
                  boolean searchesOnly,
                  boolean recursive,
                  boolean exclusive,
                  boolean keyed)
                    throws java.io.IOException,
                           NetricsException

Version of tbllock which does not require a NetricsLock object.

Throws:

java.io.IOException

NetricsException

dblock

public void dblock(java.lang.String tblName)
            throws java.io.IOException,
                   NetricsException

Deprecated. use tbllock(String)

Throws:

java.io.IOException

NetricsException

tbllock

public void tbllock(java.lang.String tblName)
             throws java.io.IOException,
                    NetricsException

For compatibility with older versions. Sets searchOnly to true and the other three parameters to false.

Throws:

java.io.IOException

NetricsException

dbunlock

public void dbunlock(java.lang.String tblName,
            boolean searchesOnly,
            boolean recursive,
            boolean exclusive,
            boolean keyed,
            NetricsLock lock)
              throws java.io.IOException,
                     NetricsException

Deprecated. use tblunlock(String,boolean,boolean,boolean,boolean,NetricsLock)

Throws:

java.io.IOException

NetricsException

tblunlock

public void tblunlock(java.lang.String tblName,
             boolean searchesOnly,
             boolean recursive,
             boolean exclusive,
             boolean keyed,
             NetricsLock lock)
               throws java.io.IOException,
                      NetricsException

Unlock a locked table.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - same as tbllock)

java.io.IOException - If an I/O error occurs

See Also:

tbllock(java.lang.String, boolean, boolean, boolean, boolean, com.netrics.likeit.NetricsLock)

dbunlock

public void dbunlock(java.lang.String tblName,
            boolean searchesOnly,
            boolean recursive,
            boolean exclusive,
            boolean keyed)
              throws java.io.IOException,
                     NetricsException

Deprecated. use tblunlock(String,boolean,boolean,boolean,boolean)

Throws:

java.io.IOException

NetricsException

tblunlock

public void tblunlock(java.lang.String tblName,
             boolean searchesOnly,
             boolean recursive,
             boolean exclusive,
             boolean keyed)
               throws java.io.IOException,
                      NetricsException

Version of tblunlock which does not require a NetricsLock object.

Throws:

java.io.IOException

NetricsException

dbunlock

public void dbunlock(java.lang.String tblName)
              throws java.io.IOException,
                     NetricsException

Deprecated. use tblunlock(String)

Throws:

java.io.IOException

NetricsException

tblunlock

public void tblunlock(java.lang.String tblName)
               throws java.io.IOException,
                      NetricsException

For compatibility with 3.2. Sets searchOnly to true and the other three parameters to false.

Throws:

java.io.IOException

NetricsException

dbrecget

public NetricsRecord[] dbrecget(java.lang.String tblName,
                       java.lang.String[] recKeys,
                       NetricsLock lock)
                         throws java.io.IOException,
                                NetricsException

Deprecated. use recget(String,String[],NetricsLock)

Throws:

java.io.IOException

NetricsException

recget

public NetricsRecord[] recget(java.lang.String tblName,
                     java.lang.String[] recKeys,
                     NetricsLock lock)
                       throws java.io.IOException,
                              NetricsException

Get multiple records from a table.

This method should typically be used instead of performing multiple single record "gets" for performance reasons.

Parameters:

tblName - The name of the table to get the records from

recKeys - The record keys of the records to get

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

An array of NetricsRecords, one per record requested

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLLOCKED, TBLNOTFOUND, DUPRECKEYS, EXPECTTBLDESC, EXPECTLIST, EXPECTRECKEY, NOTBLDESC, NORECKEY, RECNOTFOUND, UPDPARAM)

java.io.IOException - If an I/O error occurs

See Also:

NetricsRecord

dbrecget

public NetricsRecord[] dbrecget(java.lang.String tblName,
                       java.lang.String[] recKeys)
                         throws java.io.IOException,
                                NetricsException

Deprecated. use recget(String,String[])

Throws:

java.io.IOException

NetricsException

recget

public NetricsRecord[] recget(java.lang.String tblName,
                     java.lang.String[] recKeys)
                       throws java.io.IOException,
                              NetricsException

A version of recget which does not require a lock key.

Throws:

java.io.IOException

NetricsException

dbrecget

public NetricsRecord dbrecget(java.lang.String tblName,
                     java.lang.String recKey)
                       throws java.io.IOException,
                              NetricsException

Deprecated. use recget(String,String)

Throws:

java.io.IOException

NetricsException

recget

public NetricsRecord recget(java.lang.String tblName,
                   java.lang.String recKey)
                     throws java.io.IOException,
                            NetricsException

Get a single record from a table.

Parameters:

tblName - The name of the table to get the record from

recKey - The record key of the record

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecadd

public NetricsDbStats dbrecadd(java.lang.String tblName,
                      NetricsRecSrc src,
                      boolean doMaxWork,
                      NetricsLock lock)
                        throws java.io.IOException,
                               NetricsException

Deprecated. use recadd(String,NetricsRecSrc,boolean,NetricsLock,int)

Throws:

java.io.IOException

NetricsException

recadd

public NetricsTableStats recadd(java.lang.String tblName,
                       NetricsRecSrc src,
                       boolean doMaxWork,
                       NetricsLock lock,
                       int estNumRecs)
                         throws java.io.IOException,
                                NetricsException

Add multiple records to a table.

Parameters:

tblName - The name of the table to which the records will be added.

src - The record source for those records which will be added.

doMaxWork - Continue on error - adds those records which do not already exist.

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

estNumRecs - The estimated number of records in the record source. This is used by the server to determine the most efficient loading method. It need not be exact or even close.

Returns:

The stats for the table after the records have been added

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLLOCKED, TBLNOTFOUND, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, RECEXISTS, UPDPARAM, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecadd

public NetricsDbStats dbrecadd(java.lang.String tblName,
                      NetricsRecSrc src,
                      boolean doMaxWork)
                        throws java.io.IOException,
                               NetricsException

Deprecated. use recadd(String,NetricsRecSrc,boolean)

Throws:

java.io.IOException

NetricsException

recadd

public NetricsTableStats recadd(java.lang.String tblName,
                       NetricsRecSrc src,
                       boolean doMaxWork,
                       NetricsLock lock)
                         throws java.io.IOException,
                                NetricsException

recadd with no estimated record count.

Throws:

java.io.IOException

NetricsException

recadd

public NetricsTableStats recadd(java.lang.String tblName,
                       NetricsRecSrc src,
                       boolean doMaxWork,
                       int estNumRecs)
                         throws java.io.IOException,
                                NetricsException

A version of recadd which does not require a lock key.

Throws:

java.io.IOException

NetricsException

recadd

public NetricsTableStats recadd(java.lang.String tblName,
                       NetricsRecSrc src,
                       boolean doMaxWork)
                         throws java.io.IOException,
                                NetricsException

A version of recadd which does not require a lock key or est records.

Throws:

java.io.IOException

NetricsException

dbrecadd

public NetricsDbStats dbrecadd(java.lang.String tblName,
                      NetricsRecord rec)
                        throws java.io.IOException,
                               NetricsException

Deprecated. use recadd(String,NetricsRecord)

Throws:

java.io.IOException

NetricsException

recadd

public NetricsTableStats recadd(java.lang.String tblName,
                       NetricsRecord rec)
                         throws java.io.IOException,
                                NetricsException

Add a single record to a table.

Parameters:

tblName - The name of the table that the record will be added to

rec - The record which will be added

Returns:

The stats for the table after the record has been added

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecdelete

public NetricsDbStats dbrecdelete(java.lang.String tblName,
                         java.lang.String[] recKeys,
                         boolean doMaxWork,
                         NetricsLock lock)
                           throws java.io.IOException,
                                  NetricsException

Deprecated. use recdelete(String,String[],boolean,NetricsLock)

Throws:

java.io.IOException

NetricsException

recdelete

public NetricsTableStats recdelete(java.lang.String tblName,
                          java.lang.String[] recKeys,
                          boolean doMaxWork,
                          NetricsLock lock)
                            throws java.io.IOException,
                                   NetricsException

Delete multiple records from a table.

Parameters:

tblName - The name of the table from which the records will be deleted

recKeys - The record keys of the records to be deleted

doMaxWork - Continue on error - deletes those records which do exist

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

The stats for the table after the records have been deleted

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - TBLLOCKED, TBLNOTFOUND, DUPRECKEYS, EXPECTTBLDESC, EXPECTLIST, EXPECTRECKEY, NOTBLDESC, NORECKEY, RECNOTFOUND, UPDPARAM)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecdelete

public NetricsDbStats dbrecdelete(java.lang.String tblName,
                         java.lang.String[] recKeys,
                         boolean doMaxWork)
                           throws java.io.IOException,
                                  NetricsException

Deprecated. use recdelete(String,String[],boolean)

Throws:

java.io.IOException

NetricsException

recdelete

public NetricsTableStats recdelete(java.lang.String tblName,
                          java.lang.String[] recKeys,
                          boolean doMaxWork)
                            throws java.io.IOException,
                                   NetricsException

A version of recdelete which does not require a lock key.

Throws:

java.io.IOException

NetricsException

dbrecdelete

public NetricsDbStats dbrecdelete(java.lang.String tblName,
                         java.lang.String recKey)
                           throws java.io.IOException,
                                  NetricsException

Deprecated. use recdelete(String,String)

Throws:

java.io.IOException

NetricsException

recdelete

public NetricsTableStats recdelete(java.lang.String tblName,
                          java.lang.String recKey)
                            throws java.io.IOException,
                                   NetricsException

Delete a single record from a table.

Parameters:

tblName - The name of the table from which the record will be deleted

recKey - The record key of the record to be deleted

Returns:

The stats for the table after the record has been deleted

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecreplace

public NetricsDbStats dbrecreplace(java.lang.String tblName,
                          NetricsRecSrc src,
                          boolean doMaxWork,
                          NetricsLock lock)
                            throws java.io.IOException,
                                   NetricsException

Deprecated. use recreplace(String,NetricsRecSrc,boolean,NetricsLock)

Throws:

java.io.IOException

NetricsException

recreplace

public NetricsTableStats recreplace(java.lang.String tblName,
                           NetricsRecSrc src,
                           boolean doMaxWork,
                           NetricsLock lock)
                             throws java.io.IOException,
                                    NetricsException

Replace a set of records in a table.

Parameters:

tblName - The name of the table containing the records being replaced

src - The record source for those records which will be replaced

doMaxWork - Continue on error - replaces those records which do exist

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

The stats for the table after the records have been replaced

Throws:

NetricsException - If the server indicates that an error has occured (Possilbe errors - TBLLOCKED, TBLNOTFOUND, DUPRECKEYS, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, RECNOTFOUND, UPDPARAM, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

dbrecreplace

public NetricsDbStats dbrecreplace(java.lang.String tblName,
                          NetricsRecSrc src,
                          boolean doMaxWork)
                            throws java.io.IOException,
                                   NetricsException

Deprecated. use recreplace(String,NetricsRecSrc,boolean)

Throws:

java.io.IOException

NetricsException

recreplace

public NetricsTableStats recreplace(java.lang.String tblName,
                           NetricsRecSrc src,
                           boolean doMaxWork)
                             throws java.io.IOException,
                                    NetricsException

A version of recreplace which does not require a lock key.

Throws:

java.io.IOException

NetricsException

dbrecreplace

public NetricsDbStats dbrecreplace(java.lang.String tblName,
                          NetricsRecord rec)
                            throws java.io.IOException,
                                   NetricsException

Deprecated. use recreplace(String,NetricsRecord)

Throws:

java.io.IOException

NetricsException

recreplace

public NetricsTableStats recreplace(java.lang.String tblName,
                           NetricsRecord rec)
                             throws java.io.IOException,
                                    NetricsException

Replace a single existing record in a table.

Parameters:

tblName - The name of the table containing the record being replaced

rec - The new record. The value of its record key should be the record key of the record being replaced

Returns:

The stats for the table after the record has been replaced

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

recupdate

public NetricsTableStats recupdate(java.lang.String tblName,
                          NetricsRecSrc src,
                          boolean doMaxWork,
                          NetricsLock lock)
                            throws java.io.IOException,
                                   NetricsException

Update a set of records in a table.

Update operations add the record if it does not exist and replace the record if it does.

Parameters:

tblName - The name of the table containing the records being updated

src - The record source for those records which will be updated

doMaxWork - Continue on error - update as man records as possible, ignoring records with errors.

lock - A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.

Returns:

The stats for the table after the records have been updated

Throws:

NetricsException - If the server indicates that an error has occured (Possilbe errors - TBLLOCKED, TBLNOTFOUND, DUPRECKEYS, EXPECTTBLDESC, EXPECTLIST, EXPECTRECORD, FIELDLENSUM, NOTBLDESC, NORECKEY, NOSRCHTXT, NUMFIELDS, RECNOTFOUND, UPDPARAM, SHUTDOWN)

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

recupdate

public NetricsTableStats recupdate(java.lang.String tblName,
                          NetricsRecSrc src,
                          boolean doMaxWork)
                            throws java.io.IOException,
                                   NetricsException

A version of recupdate which does not require a lock key.

Throws:

java.io.IOException

NetricsException

recupdate

public NetricsTableStats recupdate(java.lang.String tblName,
                          NetricsRecord rec)
                            throws java.io.IOException,
                                   NetricsException

Update a single existing record in a table.

Parameters:

tblName - The name of the table containing the record being udpated.

rec - The new version of the record.

Returns:

The stats for the table after the record has been updated

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsTableStats

cmdstats

public NetricsCmdStats[] cmdstats(java.lang.String[] cmd_names)
                           throws java.io.IOException,
                                  NetricsException

Retrieve processing statistics for commands.

This reports statistics for the named commands. A command name of NetricsCmdStats.CMD_ALL can be used to retrieve statistics for all commands. This command will generate a report that includes all commands completed from the time the server was started until the time the request was received.

Parameters:

cmd_names - The names of the commands to be included in the report. The class NetricsCmdStats has defines of all command names.

Returns:

An array of NetricsCmdStats objects, one per requested command.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - PARAMVAL, EXPECTLIST, INTERNAL)

java.io.IOException - If an I/O error occurs

See Also:

NetricsCmdStats

cmdstats

public NetricsCmdStats[] cmdstats(java.lang.String[] cmd_names,
                         double duration)
                           throws java.io.IOException,
                                  NetricsException

Retrieve processing statistics for specified duration for commands.

This reports statistics for the named commands starting from the present moment going duration seconds into the past. A command name of NetricsCmdStats.CMD_ALL can be used to retrieve statistics for all commands.

The duration value is approximate. Each time a report request is made that does not request a specific end_time a reporting tic-mark is made at that time. The start and end time for a report will be reset to the closest time tic-mark set by a previous report. (This implies the first report always includes the entire time span since the start of the server.) The normal procedure is to request reports at a fixed interval requesting durations in units of the request interval. E.g. request a report every 5 minutes covering a 15 minute period.

Parameters:

cmd_names - The names of the commands to be included in the report. The class NetricsCmdStats has defines of all command names.

duration - The time period in seconds to be covered by this report.

Returns:

An array of NetricsCmdStats objects, one per requested command.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - PARAMVAL, PARAMCONFLICT, EXPECTLIST, INTERNAL)

java.io.IOException - If an I/O error occurs

See Also:

NetricsCmdStats

cmdstats

public NetricsCmdStats[] cmdstats(java.lang.String[] cmd_names,
                         double duration,
                         double end_time)
                           throws java.io.IOException,
                                  NetricsException

Retrieve processing statistics for specified time period.

This reports statistics for the named commands ending at the given time going duration seconds into the past from that time. A command name of NetricsCmdStats.CMD_ALL can be used to retrieve statistics for all commands.

The end time and duration are approximate. Each time a report request is made that does not request a specific end time a reporting tic-mark is made at that time. The start and end time for a report will be reset to the closest time tic-mark set by a previous report. (This implies the first report always includes the entire time span since the start of the server.) The normal procedure is to request reports at a fixed interval requesting durations in units of the request interval. E.g. request a report every 5 minutes covering a 15 minute period.

The end_time value is given in milliseconds from an arbitrary epic point, thus the only valid way to get an end_time value is to use a value returned by a previous report. So if you are requesting reports every 5 minutes and you want reports that cover the previous 5, 10, 15 minutes and the entire server time span the normal procedure would be something like:
String [] cmd_list = new { NetricsCmdStats.CMD_ALL };
NetricsCmdStats []report_5 ;
NetricsCmdStats []report_10 ;
NetricsCmdStats []report_15 ;
NetricsCmdStats []report_forever ;
report_5 = si.cmdstats(cmd_list,60.0*5.0);
double end_time = report_5[0].end_time();
report_10 = si.cmdstats(cmd_list,60.0*10.0,end_time);
report_15 = si.cmdstats(cmd_list,60.0*15.0,end_time);
report_forever = si.cmdstats(cmd_list,-1.0,end_time);


Parameters:

cmd_names - The names of the commands to be included in the report. The class NetricsCmdStats has defines of all command names.

duration - The time period in seconds to be covered by this report. -1.0 can be used to indicate "forever".

end_time - The ending time for a report.

Returns:

An array of NetricsCmdStats objects, one per requested command.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - PARAMVAL, PARAMCONFLICT, EXPECTLIST, INTERNAL)

java.io.IOException - If an I/O error occurs

See Also:

NetricsCmdStats

cmdstats_reset

public void cmdstats_reset(java.lang.String[] cmd_names,
                  double start_time)
                    throws java.io.IOException,
                           NetricsException

Reset processing statistics for the specified commands.

This resets the processing statistics, removing any collected statistics for commands completed before start_time (the present moment if < 0.0). A command name of NetricsCmdStats.CMD_ALL can be used to retrieve statistics for all commands.

The start_time value is given in milliseconds from an arbitrary epic point, thus the only valid way to get a start_time value is to use a value returned by a previous report. As with end_time the start time is approximate and matches the start time of previously tic-marked reports.

Parameters:

cmd_names - The names of the commands to be included in the report. The class NetricsCmdStats has defines of all command names.

start_time - Data for commands before this point is deleted.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - PARAMVAL, PARAMCONFLICT, EXPECTLIST, INTERNAL)

java.io.IOException - If an I/O error occurs

svrlogon

public void svrlogon()
              throws java.io.IOException,
                     NetricsException

Turn on search logging. The server must have been started with search logging enabled.

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - LOGFILE, IPCERR, IPCTIMEOUT, IPCEOF, HANDSHAKE)

java.io.IOException - If an I/O error occurs

svrlogoff

public void svrlogoff()
               throws java.io.IOException,
                      NetricsException

Turn off search logging (must be enabled when the server starts up).

Throws:

NetricsException - If the server indicates that an error has occured (Possible errors - EXPECTRTBLDESC, IPCERR, IPCTIMEOUT, IPCEOF, HANDSHAKE)

java.io.IOException - If an I/O error occurs

server_info

public NetricsServerStats server_info()
                               throws java.io.IOException,
                                      NetricsException

Retrieve the server version information. This returns the complete server version and status information.

Returns:

a NetricsServerStats object.

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

NetricsServerStats

svrversion

public java.lang.String svrversion()
                            throws java.io.IOException,
                                   NetricsException

Retrieve the version information of this interface. This returns the raw server_info string from the NetricsServerStats.

Returns:

The Netrics Server's version string

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

See Also:

server_info(), NetricsServerStats

isDecisionEngine

public boolean isDecisionEngine()
                         throws java.io.IOException,
                                NetricsException

Return true if the server indicates it is a Decision Engine.

This returns true if the server indicates it supports Decision Models. Note that older versions of the server do not send back this information, so this method will return false for servers before release 4.3.1 even if they do support the Decision Model.

Returns:

True if the server supports Decision Models, False otherwise.

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

isGIPEnabled

public boolean isGIPEnabled()
                     throws java.io.IOException,
                            NetricsException

Return true if the server indicates the GIP prefilter is enabled.

This returns true if the server indicates tables may be created with the GIP prefilter. Note that older versions of the server do not send back this information, so this method will return false for servers before release 4.3.1 even if they do support the GIP prefilter.

Returns:

as described above

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

isSortEnabled

public boolean isSortEnabled()
                      throws java.io.IOException,
                             NetricsException

Return true if the server indicates the Sort prefilter is enabled.

This returns true if the server indicates tables may be created with the Sort prefilter. Note that older versions of the server do not send back this information, so this method will return false for servers before release 4.3.1 even if they do support the Sort prefilter.

Returns:

as described above

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

isPsiEnabled

public boolean isPsiEnabled()
                     throws java.io.IOException,
                            NetricsException

Return true if the server indicates the Psi prefilter is enabled.

This returns true if the server indicates tables may be created with the Psi prefilter. Note that older versions of the server do not send back this information, so this method will return false for servers before PSI was released.

Returns:

as described above

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

version

public java.lang.String version()

Retreive the Netrics Server Interface version information.

svrshutdown

public void svrshutdown()
                 throws java.io.IOException,
                        NetricsException

Shutdown the Netrics Server.

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

svrnoop

public void svrnoop()
             throws java.io.IOException,
                    NetricsException

Perform a noop on the Netrics Server.

This method is the quickest way to determine if the Netrics server is responding or not.

Throws:

NetricsException - If the server indicates that an error has occured

java.io.IOException - If an I/O error occurs

setServerLocale

public java.util.Locale setServerLocale(java.util.Locale locale)

Sets the locale used by the interface when formatting exchanges with the server.

Use this only if the server has been set to use a non-English locale. This should only be used on the advice of TIBCO support.

Parameters:

locale - the local to use, null resets to the default locale.

Returns:

the previous locale.