it.eng.spagobi.drivers.jpxmla
Class JPXMLADriver

java.lang.Object
  extended by it.eng.spagobi.drivers.jpxmla.JPXMLADriver
All Implemented Interfaces:
it.eng.spagobi.drivers.IEngineDriver

public class JPXMLADriver
extends java.lang.Object
implements it.eng.spagobi.drivers.IEngineDriver

Driver Implementation (IEngineDriver Interface) for JPivot Engine.


Constructor Summary
JPXMLADriver()
           
 
Method Summary
protected  java.util.Map addBIParameters(it.eng.spagobi.bo.BIObject biobj, java.util.Map pars)
          Add into the parameters map the BIObject's BIParameter names and values
protected  java.util.Map addDataAccessParameter(it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName, java.util.Map pars, byte[] templateBy)
          Adds parameter for data access based on the user functionalities
private  void addLocale(java.util.Map map)
           
protected  java.util.Map applySecurity(java.util.Map pars)
          Applys changes for security reason if necessary
 it.eng.spagobi.drivers.EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject)
          Returns the url to be invoked for editing template document
protected  java.util.Map getMap(it.eng.spagobi.bo.BIObject biobj, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Starting from a BIObject extracts from it the map of the paramaeters for the execution call
 it.eng.spagobi.drivers.EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject)
          Returns the url to be invoked for creating a new template document
 java.util.Map getParameterMap(java.lang.Object biobject)
          Deprecated.  
 java.util.Map getParameterMap(java.lang.Object object, it.eng.spago.security.IEngUserProfile profile)
          Deprecated.  
 java.util.Map getParameterMap(java.lang.Object biobject, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 java.util.Map getParameterMap(java.lang.Object object, java.lang.Object subObject)
          Deprecated.  
 java.util.Map getParameterMap(java.lang.Object object, java.lang.Object subObject, it.eng.spago.security.IEngUserProfile profile)
          Deprecated.  
 java.util.Map getParameterMap(java.lang.Object object, java.lang.Object subObject, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JPXMLADriver

public JPXMLADriver()
Method Detail

addLocale

private void addLocale(java.util.Map map)

getParameterMap

public java.util.Map getParameterMap(java.lang.Object biobject,
                                     it.eng.spago.security.IEngUserProfile profile,
                                     java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Specified by:
getParameterMap in interface it.eng.spagobi.drivers.IEngineDriver
Parameters:
biObject - Object to execute
profile - Profile of the user
roleName - the name of the execution role
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object object,
                                     java.lang.Object subObject,
                                     it.eng.spago.security.IEngUserProfile profile,
                                     java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Specified by:
getParameterMap in interface it.eng.spagobi.drivers.IEngineDriver
Parameters:
biObject - Object container of the subObject
subObject - SubObject to execute
profile - Profile of the user
roleName - the name of the execution role
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object biobject)
Deprecated. 

Return a map of parameters which will be sended in the request to the engine application.

Parameters:
biObject - Object to execute
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object object,
                                     it.eng.spago.security.IEngUserProfile profile)
Deprecated. 

Return a map of parameters which will be sended in the request to the engine application.

Parameters:
biObject - Object to execute
profile - Profile of the user
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object object,
                                     java.lang.Object subObject)
Deprecated. 

Return a map of parameters which will be sended in the request to the engine application.

Parameters:
biObject - Object container of the subObject
subObject - SubObject to execute
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object object,
                                     java.lang.Object subObject,
                                     it.eng.spago.security.IEngUserProfile profile)
Deprecated. 

Return a map of parameters which will be sended in the request to the engine application.

Parameters:
biObject - Object container of the subObject
subObject - SubObject to execute
profile - Profile of the user
Returns:
Map The map of the execution call parameters

getMap

protected java.util.Map getMap(it.eng.spagobi.bo.BIObject biobj,
                               it.eng.spago.security.IEngUserProfile profile,
                               java.lang.String roleName)
Starting from a BIObject extracts from it the map of the paramaeters for the execution call

Parameters:
biobj - BIObject to execute
Returns:
Map The map of the execution call parameters

addDataAccessParameter

protected java.util.Map addDataAccessParameter(it.eng.spago.security.IEngUserProfile profile,
                                               java.lang.String roleName,
                                               java.util.Map pars,
                                               byte[] templateBy)
Adds parameter for data access based on the user functionalities

Parameters:
profile - Profile of the user
roleName - Role name of the user
pars - Map of previous parameters
template - bytes of the biobject template
Returns:
The parameter map containing parameter for data access control

addBIParameters

protected java.util.Map addBIParameters(it.eng.spagobi.bo.BIObject biobj,
                                        java.util.Map pars)
Add into the parameters map the BIObject's BIParameter names and values

Parameters:
biobj - BIOBject to execute
pars - Map of the parameters for the execution call
Returns:
Map The map of the execution call parameters

applySecurity

protected java.util.Map applySecurity(java.util.Map pars)
Applys changes for security reason if necessary

Parameters:
pars - The map of parameters
Returns:
the map of parameters to send to the engine

getEditDocumentTemplateBuildUrl

public it.eng.spagobi.drivers.EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject)
                                                                 throws it.eng.spagobi.drivers.exceptions.InvalidOperationRequest
Returns the url to be invoked for editing template document

Specified by:
getEditDocumentTemplateBuildUrl in interface it.eng.spagobi.drivers.IEngineDriver
Parameters:
biobject - The biobject
Returns:
the url to be invoked for editing template document
Throws:
it.eng.spagobi.drivers.exceptions.InvalidOperationRequest

getNewDocumentTemplateBuildUrl

public it.eng.spagobi.drivers.EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject)
                                                                throws it.eng.spagobi.drivers.exceptions.InvalidOperationRequest
Returns the url to be invoked for creating a new template document

Specified by:
getNewDocumentTemplateBuildUrl in interface it.eng.spagobi.drivers.IEngineDriver
Parameters:
biobject - The biobject
Returns:
the url to be invoked for creating a new template document
Throws:
it.eng.spagobi.drivers.exceptions.InvalidOperationRequest