com.aspc.commander.sql

Class CacheCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.CacheCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class CacheCommand
extends SQLCommand

Allows the preload of field and data cache.

if clause == "memory" then only the objects that are in memory will be matched.
Syntax

  CACHE
   [LAYER layer_name]
   [FIELD path [LOCK] [FORCE]]                               |
   [COMMAND command_text [LOCK] [FORCE]]                     |
   [UNLOCK
        [FIELD path]
        [DATA root_class [FILTER clause [MONITOR]]]
        [LIST list_class]
        [SECONDARY]
   ] |
   [LIST class_name [LOCK] [FORCE]]                          |
   [DATA class_name
        [FILTER clause [FROM from_class,linked_field]]
        [LOCK  [MONITOR]]
        [FORCE]
   ]|
   [HINT class_name
           [FILTER clause [FROM from_class,linked_field]]]        |
   [ALL class_name [LOCK] [FORCE]]                           |
   [LOAD code]                                               |
   [MODULE module_name, class_name [parameters [,...]]
  

Usage

  /* Will load the default cache commands */
  CACHE LOAD "YES";

  /* Would load the value to row cache for this field */
  CACHE FIELD MarketCap:companyCode;

  /* Would load all the data for every screen component */
  CACHE DATA SDBComponent;

  /*
   * Will load the data cache for all person records that have
   * a user id.
   */
  CACHE DATA Person FILTER "userId not null";

  /* Will load the field and data cache for the ACLs */
  CACHE ALL AccessControl;

  /* will execute a task */
  CACHE MODULE PUSHDOWN com.abc.startup.cache.PushDown;

  /* Will load the full list of row ids for a class */
  CACHE LIST person;

  /* Will load the global hints for a class */
  CACHE HINT Person

  /* Cache data and monitor for new records */
  CACHE DATA Person LOCK MONITOR

  /* Unlock lock data and monitor for new matching records */
  CACHE UNLOCK DATA Person FILTER name='Bob' MONITOR
  

THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
CacheCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) Gets the column type for the given column index, starting at one
java.lang.String	getRecordID(int row) the record ID
java.lang.Object	getValue(int row, int col) the value for this row, column

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

CacheCommand

public CacheCommand(Connection connection,
                    Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

protected void execute(@Nonnull
                       Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getColumnType

public java.lang.String getColumnType(int col)

Gets the column type for the given column index, starting at one

Parameters:

col - the column index

Returns:

String the column type

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row index

Returns:

the record ID

getValue

public java.lang.Object getValue(int row,
                                 int col)

the value for this row, column

Parameters:

row - the row index

col - the column

Returns:

Object the value for the given row and column