com.brightech.mb.workflow.js

Class SQL

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.mb.workflow.js.SQL

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class SQL
extends MBScriptableObject

Generic SQL access to the main mediabeacon database. If a workflow API already exists for accessing some piece of information, that API should be used instead.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
SQL()

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theName) Create a new SQL JavaScript object, with the given name.
java.lang.String	(JavaScript Function) escape(java.lang.String theSql) Pass string to have us escape for use querying the db
void	(JavaScript Function) query(java.lang.String theSql, org.mozilla.javascript.Function theMapperFunction) Run the given query and run the given function on each row returned by the query.
java.lang.String	(JavaScript Function) queryForBase64(java.lang.String theSql) Runs the specified SQL query.
byte[]	(JavaScript Function) queryForByteArray(java.lang.String theSql) Runs the specified SQL queue.
java.lang.Integer	(JavaScript Function) queryForInteger(java.lang.String theSql) Runs the specified SQL queue.
java.lang.String[]	(JavaScript Function) queryForList(java.lang.String theSql) Deprecated.
org.mozilla.javascript.ScriptableObject[]	(JavaScript Function) queryForMap(java.lang.String theSql) Deprecated.
java.lang.String	(JavaScript Function) queryForString(java.lang.String theSql) Runs the specified SQL queue.
void	(JavaScript Function) setExternalDatabaseXML(ExternalDatabaseInformation theInformation) Changes the connection properties of this SQL object to connect to an external database instead of the MediaBeacon database.
java.lang.Integer	(JavaScript Function) update(java.lang.String theSql) Run a single SQL update operation (such as an insert, update or delete statement).

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

SQL

public SQL()

Method Detail

jsConstructor

public void jsConstructor(java.lang.String theName)

Create a new SQL JavaScript object, with the given name.

Parameters:

theName - The name that will be used when logging operations performed on this object.

(JavaScript Function) setExternalDatabaseXML

public void (JavaScript Function) setExternalDatabaseXML(ExternalDatabaseInformation theInformation)

Changes the connection properties of this SQL object to connect to an external database instead of the MediaBeacon database.

Parameters:

theInformation - An ExternalDatabaseInformation object to use when connecting to the external DB. The constructor for for ExternalDatabaseInformation takes 3 parameters: connection string, user name, and password. Should be called like "ExternalDatabaseInformation('aConnectionString', 'aUsername', 'aPassword');"

(JavaScript Function) escape

public java.lang.String (JavaScript Function) escape(java.lang.String theSql)

Pass string to have us escape for use querying the db

Parameters:

theSql - to escape

Returns:

escaped sql string, specific to the db using

(JavaScript Function) queryForString

public java.lang.String (JavaScript Function) queryForString(java.lang.String theSql)

Runs the specified SQL queue.

Parameters:

theSql - the SQL queue.

Returns:

the queue result.

(JavaScript Function) queryForInteger

public java.lang.Integer (JavaScript Function) queryForInteger(java.lang.String theSql)

Runs the specified SQL queue.

Parameters:

theSql - the SQL queue.

Returns:

the queue result.

(JavaScript Function) queryForList

@Deprecated
public java.lang.String[] (JavaScript Function) queryForList(java.lang.String theSql)

Deprecated.

Runs the specified SQL queue.

Parameters:

theSql - the SQL queue.

Returns:

the queue result array.

(JavaScript Function) queryForMap

@Deprecated
public org.mozilla.javascript.ScriptableObject[] (JavaScript Function) queryForMap(java.lang.String theSql)

Deprecated.

Runs the specified SQL queue.

Parameters:

theSql - the SQL queue.

Returns:

the queue result map.

(JavaScript Function) queryForByteArray

public byte[] (JavaScript Function) queryForByteArray(java.lang.String theSql)

Runs the specified SQL queue.

Parameters:

theSql - the SQL queue.

Returns:

the queue result.

(JavaScript Function) queryForBase64

public java.lang.String (JavaScript Function) queryForBase64(java.lang.String theSql)

Runs the specified SQL query.

Parameters:

theSql - the SQL queue.

Returns:

the queue result.

(JavaScript Function) update

public java.lang.Integer (JavaScript Function) update(java.lang.String theSql)

Run a single SQL update operation (such as an insert, update or delete statement).

Parameters:

theSql - the SQL queue to run.

(JavaScript Function) query

public void (JavaScript Function) query(java.lang.String theSql,
                             org.mozilla.javascript.Function theMapperFunction)

Run the given query and run the given function on each row returned by the query. The function is run on each row in the result set and is given a parameter which is map which contains each column name as the key and each column value as the value.

Parameters:

theSql - the SQL query to run

theMapperFunction - the mapper function to run