|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectit.eng.spagobi.behaviouralmodel.lov.bo.QueryDetail
public class QueryDetail
Defines the QueryDetail
objects. This object is used to store
Query Wizard detail information.
Field Summary | |
---|---|
static java.lang.String |
DIALECT_HSQL
|
static java.lang.String |
DIALECT_INGRES
|
static java.lang.String |
DIALECT_MYSQL
|
static java.lang.String |
DIALECT_ORACLE
|
static java.lang.String |
DIALECT_ORACLE9i10g
|
static java.lang.String |
DIALECT_POSTGRES
|
static java.lang.String |
DIALECT_SQLSERVER
|
Constructor Summary | |
---|---|
QueryDetail()
constructor. |
|
QueryDetail(java.lang.String dataDefinition)
constructor. |
Method Summary | |
---|---|
QueryDetail |
clone()
|
static QueryDetail |
fromXML(java.lang.String dataDefinition)
Splits an XML string by using some SourceBean object methods
in order to obtain the source QueryDetail objects whom XML has been
built. |
java.lang.String |
getDataSource()
Gets the data source. |
java.lang.String |
getDescriptionColumnName()
Gets the description column name. |
java.util.List |
getInvisibleColumnNames()
Gets the invisible column names. |
java.lang.String |
getLovResult(it.eng.spago.security.IEngUserProfile profile,
java.util.List<ObjParuse> dependencies,
ExecutionInstance executionInstance)
Returns the result of the lov for a given user and for a particular execution instance with the given dependencies (optional). |
java.util.List |
getProfileAttributeNames()
Gets the list of names of the profile attributes required. |
java.lang.String |
getQueryDefinition()
Gets the query definition. |
java.lang.String |
getValueColumnName()
Gets the value column name. |
java.util.List |
getVisibleColumnNames()
Gets the visible column names. |
java.lang.String |
getWrappedStatement(java.util.List<ObjParuse> dependencies,
ExecutionInstance executionInstance)
This methods builds the in-line view that filters the original lov using the dependencies. |
void |
loadFromXML(java.lang.String dataDefinition)
loads the lov from an xml string. |
boolean |
requireProfileAttributes()
Checks if the lov requires one or more profile attributes. |
void |
setDataSource(java.lang.String dataSource)
Sets the data source. |
void |
setDescriptionColumnName(java.lang.String descriptionColumnName)
Sets the description column name. |
void |
setInvisibleColumnNames(java.util.List invisibleColumnNames)
Sets the invisible column names. |
void |
setQueryDefinition(java.lang.String queryDefinition)
Sets the query definition. |
void |
setValueColumnName(java.lang.String valueColumnName)
Sets the value column name. |
void |
setVisibleColumnNames(java.util.List visibleColumnNames)
Sets the visible column names. |
java.lang.String |
toXML()
serialize the lov to an xml string. |
java.util.List |
validateValues(it.eng.spago.security.IEngUserProfile profile,
BIObjectParameter biparam)
This methods find out if the input parameters' values are admissible for this QueryDetail instance, i.e. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DIALECT_MYSQL
public static final java.lang.String DIALECT_POSTGRES
public static final java.lang.String DIALECT_ORACLE
public static final java.lang.String DIALECT_HSQL
public static final java.lang.String DIALECT_ORACLE9i10g
public static final java.lang.String DIALECT_SQLSERVER
public static final java.lang.String DIALECT_INGRES
Constructor Detail |
---|
public QueryDetail()
public QueryDetail(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
dataDefinition
- the xml representation of the lov
it.eng.spago.base.SourceBeanException
- the source bean exceptionMethod Detail |
---|
public void loadFromXML(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
loadFromXML
in interface ILovDetail
dataDefinition
- the xml definition of the lov
it.eng.spago.base.SourceBeanException
- the source bean exceptionpublic java.lang.String toXML()
toXML
in interface ILovDetail
public java.lang.String getLovResult(it.eng.spago.security.IEngUserProfile profile, java.util.List<ObjParuse> dependencies, ExecutionInstance executionInstance) throws java.lang.Exception
ILovDetail
getLovResult
in interface ILovDetail
profile
- the profile of the userdependencies
- the dependencies to be considered for the lov. It may be null,
since when testing a lov, there is no correlation.executionInstance
- the execution instance object, that contains the BIObject
being executed. It may be null, since when testing a lov,
there is no execution instance.
java.lang.Exception
- the exceptionthrows Exception;
public java.lang.String getWrappedStatement(java.util.List<ObjParuse> dependencies, ExecutionInstance executionInstance)
dependencies
- The dependencies' configuration to be considered into the queryexecutionInstance
- The execution instance (useful to retrieve dependencies values)
public java.util.List validateValues(it.eng.spago.security.IEngUserProfile profile, BIObjectParameter biparam) throws java.lang.Exception
profile
- The user profilebiparam
- The BIObjectParameter with the values that must be validated
java.lang.Exception
public java.util.List getProfileAttributeNames() throws java.lang.Exception
getProfileAttributeNames
in interface ILovDetail
java.lang.Exception
- the exceptionpublic boolean requireProfileAttributes() throws java.lang.Exception
requireProfileAttributes
in interface ILovDetail
java.lang.Exception
- the exceptionpublic static QueryDetail fromXML(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
SourceBean
object methods
in order to obtain the source QueryDetail
objects whom XML has been
built.
dataDefinition
- The XML input String
QueryDetail
object
it.eng.spago.base.SourceBeanException
- If a SourceBean Exception occurredpublic java.lang.String getDataSource()
public void setDataSource(java.lang.String dataSource)
dataSource
- the new data sourcepublic java.lang.String getQueryDefinition()
public void setQueryDefinition(java.lang.String queryDefinition)
queryDefinition
- the new query definitionpublic java.lang.String getDescriptionColumnName()
ILovDetail
getDescriptionColumnName
in interface ILovDetail
public void setDescriptionColumnName(java.lang.String descriptionColumnName)
ILovDetail
setDescriptionColumnName
in interface ILovDetail
descriptionColumnName
- the new description column namepublic java.util.List getInvisibleColumnNames()
ILovDetail
getInvisibleColumnNames
in interface ILovDetail
public void setInvisibleColumnNames(java.util.List invisibleColumnNames)
ILovDetail
setInvisibleColumnNames
in interface ILovDetail
invisibleColumnNames
- the new invisible column namespublic java.lang.String getValueColumnName()
ILovDetail
getValueColumnName
in interface ILovDetail
public void setValueColumnName(java.lang.String valueColumnName)
ILovDetail
setValueColumnName
in interface ILovDetail
valueColumnName
- the new value column namepublic java.util.List getVisibleColumnNames()
ILovDetail
getVisibleColumnNames
in interface ILovDetail
public void setVisibleColumnNames(java.util.List visibleColumnNames)
ILovDetail
setVisibleColumnNames
in interface ILovDetail
visibleColumnNames
- the new visible column namespublic QueryDetail clone()
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |