Package de.businesscode.bcdui.wrs.load

Class WrqBindingSetVirtual

java.lang.Object

de.businesscode.bcdui.wrs.load.WrqBindingSetVirtual

All Implemented Interfaces:

BindingSet, WrqBindingSet, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

WrqBindingSetFromDerivedTable, WrqBindingSetFromTableReference

public abstract class WrqBindingSetVirtual
extends java.lang.Object
implements WrqBindingSet

Represents a virtual BindingSet derived on runtime from parts of a Wrs

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.businesscode.bcdui.binding.BindingSet

BindingSet.SECURITY_OPS

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,BindingItem>	bindingItems
protected SqlFromSubSelect	currentSelect
protected java.lang.String	name
protected java.util.Set<StandardBindingSet>	resolvedBindingSets
protected java.lang.String	sqlAlias
protected SQLStatementWithParams	sqlStatementWithParams
protected java.lang.String	tableName
protected java.util.List<java.lang.Class<? extends Modifier>>	wrqModifiers

Fields inherited from interface de.businesscode.bcdui.binding.BindingSet

DEFAULT_DATABASE_SOURCENAME

Constructor Summary

Constructors

Constructor	Description
WrqBindingSetVirtual(SqlFromSubSelect currentSelect)

Method Summary

Modifier and Type	Method	Description
void	addRelation(Relation p_relation)	adds a new relation into ArrayList
void	assurePermissionDefined(BindingSet.SECURITY_OPS operation)	we check here if the application has set up the subjectSettings.
void	assurePermitted(BindingSet.SECURITY_OPS operation)	check if given operation is permitted according to permissions set on subject in scope
BindingItem	get(java.lang.String key)	Gets a BindingItem by its unique name and throws an Exception if it is not present.
java.util.Collection<BindingItem>	get(java.util.Collection<java.lang.String> keys)	Get binding items by ids.
BindingItem	getBindingItemFromRelation(Relation pRelation, java.lang.String itemName)	Method getBindingItemFromRelation
java.util.Collection<java.lang.String>	getBindingItemNames()	getBindingItemNames
abstract java.lang.String	getJdbcResourceName()	Gets the database name the table of the BindingSet is located in.
BindingItem[]	getKeyBindingItems()	Retrieves the list of key BindingItems for this binding set which may contain no entries.
java.lang.String	getName()	Gets the unique name of the BindingSet.
java.util.ArrayList<Relation>	getRelations()
java.util.Set<StandardBindingSet>	getResolvedBindingSets()	All non-virtual BindingSets that were used at the end, BindingGroups are being resolved to the actually used BindingSets
Security	getSecurity()
java.lang.String	getSqlAlias()	SQL alias of this BindingSet during this query
SQLStatementWithParams	getSQLStatementWithParams()	Returns a table expression and if it is a complex one (subselect with where for example) it may come with variables to be bound as host variables
abstract SQLStatementWithParams	getSubjectFilterExpression(WrqInfo wrqInfo)	Return SubjectFilters to be applied for our virtual BindingSet
SubjectFilters	getSubjectFilters()	Gets the SubjectFilters definition for this BindingSet which may be null.
java.lang.String	getTableReference()	Returns a table reference.
WriteProcessing	getWriteProcessing()
java.util.List<java.lang.Class<? extends Modifier>>	getWrqModifiers()	A list of Wrq modifier classes to be applied on all requests for this BindingSet before generating the SQL This is completely transparent to the caller, the answer Wrs does show the original WrsRequest
boolean	hasCustomItem()
boolean	hasItem(java.lang.String key)	tells if this binding-set contains an item
boolean	hasKeyBindingItems()	Tests if the BindingSet hat key BindingItems.
boolean	hasSubjectFilters()	Tells if the binding set has subject filters.
boolean	isAllowSelectAllColumns()	isAllowSelectAllColumns
boolean	isBackendCanBypassSubjectFilter()	isBackendCanBypassSubjectFilter

Methods inherited from class java.lang.Object

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

Field Detail

tableName

protected java.lang.String tableName

name

protected java.lang.String name

sqlAlias

protected java.lang.String sqlAlias

bindingItems

protected java.util.Map<java.lang.String,BindingItem> bindingItems

wrqModifiers

protected java.util.List<java.lang.Class<? extends Modifier>> wrqModifiers

resolvedBindingSets

protected java.util.Set<StandardBindingSet> resolvedBindingSets

sqlStatementWithParams

protected final SQLStatementWithParams sqlStatementWithParams

currentSelect

protected final SqlFromSubSelect currentSelect

Constructor Detail

WrqBindingSetVirtual

public WrqBindingSetVirtual(SqlFromSubSelect currentSelect)
                     throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getResolvedBindingSets

public java.util.Set<StandardBindingSet> getResolvedBindingSets()

Description copied from interface: BindingSet

All non-virtual BindingSets that were used at the end, BindingGroups are being resolved to the actually used BindingSets

Specified by:

getResolvedBindingSets in interface BindingSet

Returns:

getSqlAlias

public java.lang.String getSqlAlias()

Description copied from interface: WrqBindingSet

SQL alias of this BindingSet during this query

Specified by:

getSqlAlias in interface WrqBindingSet

Returns:

getName

public java.lang.String getName()

Description copied from interface: BindingSet

Gets the unique name of the BindingSet.

Specified by:

getName in interface BindingSet

Returns:

The unique BindingSet name.

hasSubjectFilters

public boolean hasSubjectFilters()

Description copied from interface: BindingSet

Tells if the binding set has subject filters.

Specified by:

hasSubjectFilters in interface BindingSet

Returns:

True, if there is at least one SubjectFilter inside this BindingSet.

getSubjectFilters

public SubjectFilters getSubjectFilters()

Description copied from interface: BindingSet

Gets the SubjectFilters definition for this BindingSet which may be null.

Specified by:

getSubjectFilters in interface BindingSet

Returns:

SubjectFilters for given BindingSet or null

getJdbcResourceName

public abstract java.lang.String getJdbcResourceName()

Description copied from interface: BindingSet

Gets the database name the table of the BindingSet is located in.

Specified by:

getJdbcResourceName in interface BindingSet

Returns:

All tables need to be on the same database, so here we return one from a random resolved BindingSet

isBackendCanBypassSubjectFilter

public boolean isBackendCanBypassSubjectFilter()

Description copied from interface: BindingSet

isBackendCanBypassSubjectFilter

Specified by:

isBackendCanBypassSubjectFilter in interface BindingSet

Returns:

true if it is allowed for the backend to bypass SubjectFilters

isAllowSelectAllColumns

public boolean isAllowSelectAllColumns()

Description copied from interface: BindingSet

isAllowSelectAllColumns

Specified by:

isAllowSelectAllColumns in interface BindingSet

Returns:

true if it is allowed to select all columns from this BindingSet.

get

public BindingItem get(java.lang.String key)
                throws BindingNotFoundException

Description copied from interface: BindingSet

Gets a BindingItem by its unique name and throws an Exception if it is not present.

Specified by:

get in interface BindingSet

Parameters:

key - The name of the BindingItem.

Returns:

A BindingItem with the specified name.

Throws:

BindingNotFoundException - If there is no BindingItem with the denoted name.

hasItem

public boolean hasItem(java.lang.String key)

Description copied from interface: BindingSet

tells if this binding-set contains an item

Specified by:

hasItem in interface BindingSet

Returns:

hasCustomItem

public boolean hasCustomItem()

Specified by:

hasCustomItem in interface BindingSet

Returns:

TRUE if contains at least one custom element from StandardNamespaceContext.CUST_NAMESPACE

get

public java.util.Collection<BindingItem> get(java.util.Collection<java.lang.String> keys)
                                      throws BindingNotFoundException

Description copied from interface: BindingSet

Get binding items by ids.

Specified by:

get in interface BindingSet

Throws:

BindingNotFoundException

See Also:

Bindings.get(String)

getBindingItemNames

public java.util.Collection<java.lang.String> getBindingItemNames()

Description copied from interface: BindingSet

getBindingItemNames

Specified by:

getBindingItemNames in interface BindingSet

Returns:

names of all items defined in the bindingSet

getBindingItemFromRelation

public BindingItem getBindingItemFromRelation(Relation pRelation,
                                              java.lang.String itemName)
                                       throws BindingException

Description copied from interface: BindingSet

Method getBindingItemFromRelation

Specified by:

getBindingItemFromRelation in interface BindingSet

itemName - - requested binding item name

Returns:

BindingItem object or null if not found

Throws:

BindingException

hasKeyBindingItems

public boolean hasKeyBindingItems()

Description copied from interface: BindingSet

Tests if the BindingSet hat key BindingItems.

Specified by:

hasKeyBindingItems in interface BindingSet

Returns:

True, if there is a BindingItem which is declared as key item.

getKeyBindingItems

public BindingItem[] getKeyBindingItems()

Description copied from interface: BindingSet

Retrieves the list of key BindingItems for this binding set which may contain no entries.

Specified by:

getKeyBindingItems in interface BindingSet

Returns:

An array of the BindingItems with the isKey attribute set to "true".

addRelation

public void addRelation(Relation p_relation)

Description copied from interface: BindingSet

adds a new relation into ArrayList

Specified by:

addRelation in interface BindingSet

getRelations

public java.util.ArrayList<Relation> getRelations()

Specified by:

getRelations in interface BindingSet

getWriteProcessing

public WriteProcessing getWriteProcessing()

Specified by:

getWriteProcessing in interface BindingSet

assurePermissionDefined

public void assurePermissionDefined(BindingSet.SECURITY_OPS operation)
                             throws SecurityMissingForBindingException

Description copied from interface: BindingSet

we check here if the application has set up the subjectSettings. In case it is set up, the binding-set HAS TO define the Security context for given operation otherwise we throw SecurityMissingException

Specified by:

assurePermissionDefined in interface BindingSet

Parameters:

operation - - to assure the permission is defined for

Throws:

SecurityMissingForBindingException

assurePermitted

public void assurePermitted(BindingSet.SECURITY_OPS operation)
                     throws SecurityException

Description copied from interface: BindingSet

check if given operation is permitted according to permissions set on subject in scope

Specified by:

assurePermitted in interface BindingSet

Parameters:

operation - - to assure permission for

Throws:

SecurityException

getSecurity

public Security getSecurity()

Specified by:

getSecurity in interface BindingSet

Returns:

security context to this binding, may be NULL if no security configured

getWrqModifiers

public java.util.List<java.lang.Class<? extends Modifier>> getWrqModifiers()

Description copied from interface: BindingSet

A list of Wrq modifier classes to be applied on all requests for this BindingSet before generating the SQL This is completely transparent to the caller, the answer Wrs does show the original WrsRequest

Specified by:

getWrqModifiers in interface BindingSet

Returns:

getTableReference

public java.lang.String getTableReference()

Description copied from interface: BindingSet

Returns a table reference. Can be a plain table name (with alias) or a join of tables

Specified by:

getTableReference in interface BindingSet

Returns:

getSQLStatementWithParams

public SQLStatementWithParams getSQLStatementWithParams()

Description copied from interface: BindingSet

Returns a table expression and if it is a complex one (subselect with where for example) it may come with variables to be bound as host variables

Specified by:

getSQLStatementWithParams in interface BindingSet

Returns:

getSubjectFilterExpression

public abstract SQLStatementWithParams getSubjectFilterExpression(WrqInfo wrqInfo)
                                                           throws BindingException

Return SubjectFilters to be applied for our virtual BindingSet

Specified by:

getSubjectFilterExpression in interface WrqBindingSet

Returns:

Throws:

BindingException