org.jsimpledb.parse

Class ParseSession

java.lang.Object

org.jsimpledb.Session

org.jsimpledb.parse.ParseSession

public class ParseSession
extends Session

A Session with support for parsing Java expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParseSession.Action Callback interface used by ParseSession.performParseSessionAction() and ParseSession.performParseSessionActionWithCurrentTransaction().

Nested classes/interfaces inherited from class org.jsimpledb.Session

Session.HasTransactionOptions, Session.RetryableAction, Session.TransactionalAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARSE_FUNCTIONS_DESCRIPTOR_RESOURCE Classpath XML file resource describing available Functions: "META-INF/jsimpledb/parse-function-implementations.xml".

Fields inherited from class org.jsimpledb.Session

DEFAULT_INITIAL_RETRY_DELAY, DEFAULT_MAX_RETRIES, DEFAULT_MAXIMUM_RETRY_DELAY, log

Constructor Summary

Constructors

Constructor and Description
ParseSession(Database db) Constructor for SessionMode.CORE_API mode.
ParseSession(JSimpleDB jdb) Constructor for SessionMode.JSIMPLEDB mode.
ParseSession(KVDatabase kvdb) Constructor for SessionMode.KEY_VALUE mode.

Method Summary

Modifier and Type	Method and Description
SortedMap<String,Function>	getFunctions() Get the Functions registered with this instance.
Parser<? extends Node>	getIdentifierParser() Get the current standalone identifier parser.
Set<String>	getImports() Get currently configured Java imports.
SortedMap<String,Value>	getVars() Get all variables set on this instance.
void	loadFunctionsFromClasspath() Scan the classpath for Functions and register them.
boolean	performParseSessionAction(ParseSession.Action action) Perform the given action in the context of this session.
boolean	performParseSessionActionWithCurrentTransaction(ParseSession.Action action) Associate the current JTransaction with this instance, if not already associated, while performing the given action.
void	registerFunction(Function function) Register the given Function.
String	relativizeClassName(Class<?> klass) Relativize the given class's name, so that it is as short as possible given the configured imports.
Class<?>	resolveClass(String name, boolean allowPrimitive) Resolve a class name against this instance's currently configured class imports.
void	setIdentifierParser(Parser<? extends Node> identifierParser) Set the standalone identifier parser.

Methods inherited from class org.jsimpledb.Session

getDatabase, getDatabaseDescription, getInitialRetryDelay, getJSimpleDB, getJTransaction, getKVDatabase, getKVTransaction, getMaximumRetryDelay, getMaxRetries, getMode, getNameIndex, getSchemaModel, getSchemaVersion, getTransaction, getValidationMode, isAllowNewSchema, isReadOnly, isTransactionOpen, performSessionAction, performSessionActionWithCurrentTransaction, reportException, setAllowNewSchema, setDatabaseDescription, setInitialRetryDelay, setMaximumRetryDelay, setMaxRetries, setMode, setReadOnly, setRollbackOnly, setSchemaModel, setSchemaVersion, setValidationMode

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_FUNCTIONS_DESCRIPTOR_RESOURCE

public static final String PARSE_FUNCTIONS_DESCRIPTOR_RESOURCE

Classpath XML file resource describing available Functions: "META-INF/jsimpledb/parse-function-implementations.xml".

Example:

  <parse-function-implementations>
      <parse-function-implementation class="com.example.MyFunction"/>
  </parse-function-implementations>
 

Instances must have a public constructor taking either zero parameters or one ParseSession parameter.

See Also:

loadFunctionsFromClasspath(), Constant Field Values

Constructor Detail

ParseSession

public ParseSession(KVDatabase kvdb)

Constructor for SessionMode.KEY_VALUE mode.

Parameters:

kvdb - key/value database

Throws:

IllegalArgumentException - if kvdb is null

ParseSession

public ParseSession(Database db)

Constructor for SessionMode.CORE_API mode.

Parameters:

db - core database

Throws:

IllegalArgumentException - if db is null

ParseSession

public ParseSession(JSimpleDB jdb)

Constructor for SessionMode.JSIMPLEDB mode.

Parameters:

jdb - database

Throws:

IllegalArgumentException - if jdb is null

Method Detail

getImports

public Set<String> getImports()

Get currently configured Java imports.

Each entry should of the form foo.bar.Name or foo.bar.*.

Returns:

configured imports

getFunctions

public SortedMap<String,Function> getFunctions()

Get the Functions registered with this instance.

Returns:

registered functions indexed by name

getVars

public SortedMap<String,Value> getVars()

Get all variables set on this instance.

Returns:

variables indexed by name

loadFunctionsFromClasspath

public void loadFunctionsFromClasspath()

Scan the classpath for Functions and register them.

See Also:

PARSE_FUNCTIONS_DESCRIPTOR_RESOURCE

registerFunction

public void registerFunction(Function function)

Register the given Function.

Any existing Function with the same name will be replaced.

Parameters:

function - new function

Throws:

IllegalArgumentException - if function is null

getIdentifierParser

public Parser<? extends Node> getIdentifierParser()

Get the current standalone identifier parser.

Returns:

current identifier parser, if any, otherwise null

setIdentifierParser

public void setIdentifierParser(Parser<? extends Node> identifierParser)

Set the standalone identifier parser.

The configured identifier parser, if any, is invoked on standalone identifiers. This allows for configurable behavior with respect to resolving such identifiers.

Typically when installing a new parser, the previous parser (if any) is set as its delegate.

Parameters:

identifierParser - parser for standalone identifiers, or null for none

resolveClass

public Class<?> resolveClass(String name,
                             boolean allowPrimitive)

Resolve a class name against this instance's currently configured class imports.

Parameters:

name - class name as it would appear in the Java language

allowPrimitive - whether to allow primitive types like int

Returns:

resolved class

Throws:

IllegalArgumentException - if name cannot be resolved

relativizeClassName

public String relativizeClassName(Class<?> klass)

Relativize the given class's name, so that it is as short as possible given the configured imports. For example, for class String this will return String, but for class ArrayList this will return java.util.ArrayList unless java.util.* has been imported.

Parameters:

klass - class whose name to relativize

Returns:

relativized class name

Throws:

IllegalArgumentException - if klass is null

performParseSessionAction

public boolean performParseSessionAction(ParseSession.Action action)

Perform the given action in the context of this session.

This is a ParseSession-specific overload of Session.performSessionAction(); see that method for details.

Parameters:

action - action to perform, possibly within a transaction

Returns:

true if action completed successfully, false if a transaction could not be created or action threw an exception

Throws:

IllegalArgumentException - if action is null

performParseSessionActionWithCurrentTransaction

public boolean performParseSessionActionWithCurrentTransaction(ParseSession.Action action)

Associate the current JTransaction with this instance, if not already associated, while performing the given action.

This is a ParseSession-specific overload of Session.performSessionActionWithCurrentTransaction(); see that method for details.

Parameters:

action - action to perform

Returns:

true if action completed successfully, false if action threw an exception

Throws:

IllegalStateException - if there is a different open transaction already associated with this instance

IllegalStateException - if this instance is not in mode SessionMode.JSIMPLEDB

IllegalArgumentException - if action is null