velosurf.context
Class DBReference

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          velosurf.context.DBReference

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, ReadOnlyMap

Direct Known Subclasses:

Velosurf, VelosurfTool

public class DBReference
extends java.util.HashMap
implements ReadOnlyMap

A context wrapper for the main database connection object.

The "$db" context variable is assigned a new instance of this class at each velocity parsing.

Author:

Claude Brisson

See Also:

Serialized Form

Field Summary

protected java.util.Map	cache a cache used by the generic getter - it's purpose is to avoid the creation of several attribute references for the same multivalued attribute.
protected Database	db the wrapped database connection
protected java.util.Map	externalParams The map of external query parameters used by children attributes
protected UserContext	userContext a reference to the user context

Constructor Summary

protected	DBReference() Default constructor for use by derived classes
	DBReference(Database db) Constructs a new database reference
	DBReference(Database db, UserContext userContext) Constructs a new database reference

Method Summary

java.lang.String	deobfuscate(java.lang.Object value) de-obfuscate the given value
java.lang.Object	get(java.lang.Object key) Generic getter, used to access entities or root attributes by their name.
java.lang.String	getSchema() get the schema
protected void	init(Database db) protected initialization method
protected void	init(Database db, UserContext userContext) protected initialization method
java.lang.String	obfuscate(java.lang.Object value) obfuscate the given value
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Generic setter used to set external params for children attributes

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface velosurf.sql.ReadOnlyMap

keySet

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

db

protected Database db

the wrapped database connection

cache

protected java.util.Map cache

a cache used by the generic getter - it's purpose is to avoid the creation of several attribute references for the same multivalued attribute.

externalParams

protected java.util.Map externalParams

The map of external query parameters used by children attributes

userContext

protected UserContext userContext

a reference to the user context

Constructor Detail

DBReference

protected DBReference()

Default constructor for use by derived classes

DBReference

public DBReference(Database db)

Constructs a new database reference

Parameters:

db - the wrapped database connection

DBReference

public DBReference(Database db,
                   UserContext userContext)

Constructs a new database reference

Parameters:

db - the wrapped database connection

Method Detail

init

protected void init(Database db)

protected initialization method

Parameters:

db - database connection

init

protected void init(Database db,
                    UserContext userContext)

protected initialization method

Parameters:

db - database connection

get

public java.lang.Object get(java.lang.Object key)

Generic getter, used to access entities or root attributes by their name.

For attributes, the return value depends upon the type of the attribute :

• if the attribute is multivalued, returns an AttributeReference.
• if the attribute is singlevalued, returns an Instance.
• if the attribute is scalar, returns a String.

Specified by:

get in interface java.util.Map

Specified by:

get in interface ReadOnlyMap

Overrides:

get in class java.util.HashMap

Parameters:

key - the name of the desired entity or root attribute.

Returns:

an entity, an attribute reference, an instance, a string or null if not found. See See above.

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Generic setter used to set external params for children attributes

Specified by:

put in interface java.util.Map

Overrides:

put in class java.util.HashMap

Parameters:

key - name of the external parameter

value - value given to the external parameter

Returns:

the previous value, if any

getSchema

public java.lang.String getSchema()

get the schema

Returns:

the schema

obfuscate

public java.lang.String obfuscate(java.lang.Object value)

obfuscate the given value

Parameters:

value - value to obfuscate

Returns:

obfuscated value

deobfuscate

public java.lang.String deobfuscate(java.lang.Object value)

de-obfuscate the given value

Parameters:

value - value to de-obfuscate

Returns:

obfuscated value