|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectit.eng.spagobi.analiticalmodel.document.AnalyticalModelDocumentManagementAPI
public class AnalyticalModelDocumentManagementAPI
Field Summary | |
---|---|
static java.lang.Integer |
MODIFIABLE
|
static java.lang.Integer |
MULTIVALUE
|
static java.lang.Integer |
REQUIRED
|
static java.lang.Integer |
VISIBLE
|
Constructor Summary | |
---|---|
AnalyticalModelDocumentManagementAPI(it.eng.spago.security.IEngUserProfile userProfile)
|
Method Summary | |
---|---|
void |
addParameter(BIObject documentDescriptor,
java.lang.Object analyticalDriverDescriptor,
int priority)
Add the analytical driver associated to the analyticalDriverDescriptor to the document associated to the documentDescriptor. |
void |
copyParameters(java.lang.Object sourceDocument,
java.lang.Object destinationDocument)
Copy all the parameters associated with sourceDocument to destinationDocument |
Parameter |
getAnalyticalDriver(java.lang.Object analyticalDriverDescriptor)
Utility method. |
BIObject |
getDocument(java.lang.Object docDescriptor)
Utility method. |
ObjMetadata |
getMetadataProperty(java.lang.Object matadataPropertyDescriptor)
Utility method. |
boolean |
isAnExistingDocument(BIObject document)
|
void |
propagateDatasetParameters(it.eng.spagobi.tools.dataset.bo.IDataSet dataset,
BIObject document)
This method add a parameter to the document for each parameter associated with the dataset. |
boolean |
saveDocument(BIObject document,
ObjTemplate template)
|
void |
saveDocumentMetadataProperties(java.lang.Object documentDescriptor,
java.lang.Integer subObjectId,
org.json.JSONArray metadataJSON)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Integer REQUIRED
public static final java.lang.Integer MODIFIABLE
public static final java.lang.Integer MULTIVALUE
public static final java.lang.Integer VISIBLE
Constructor Detail |
---|
public AnalyticalModelDocumentManagementAPI(it.eng.spago.security.IEngUserProfile userProfile)
Method Detail |
---|
public BIObject getDocument(java.lang.Object docDescriptor)
docDescriptor
- Could be the document itself (an object of type BIObject), its id (an object
of type Integer) or its label (an object of type String)
public Parameter getAnalyticalDriver(java.lang.Object analyticalDriverDescriptor)
analyticalDriverDescriptor
- Could be the analytical driver itself (an object of type Parameter)
or its label (an object of type String)
public ObjMetadata getMetadataProperty(java.lang.Object matadataPropertyDescriptor)
matadataPropertyDescriptor
- Could be the metadata property's id (an object of type Integer)
or its label (an object of type String)
public boolean isAnExistingDocument(BIObject document)
document
- The document
public boolean saveDocument(BIObject document, ObjTemplate template)
document
- The document to save (insert or modify)template
- The new template of the document
public void saveDocumentMetadataProperties(java.lang.Object documentDescriptor, java.lang.Integer subObjectId, org.json.JSONArray metadataJSON)
documentDescriptor
- The descriptor of the target documentsubObjectId
- The id of the target subobject (optional). If it is nos specified the metadata properties
will be applied to the main objectmetadataJSON
- The metadata properties to add. They are encoded as an array of object like the following one
{
meta_id: NUMBER
, meta_name: STRING
, meta_content: STRING
}
at least one between attributes meta_id and meta_name must be set.
TODO use this method to refactor class SaveMetadataActionpublic void copyParameters(java.lang.Object sourceDocument, java.lang.Object destinationDocument)
sourceDocument
- can be an object of type BIObject or an Integer
representing the id of the source documentdestinationDocument
- can be an object of type BIObject or an Integer
representing the id of the destination documentpublic void propagateDatasetParameters(it.eng.spagobi.tools.dataset.bo.IDataSet dataset, BIObject document)
dataset
- the datsetdocument
- the documentpublic void addParameter(BIObject documentDescriptor, java.lang.Object analyticalDriverDescriptor, int priority)
documentDescriptor
- can be the document itself(BIObject), the document id(Integer) or the document label(String)analyticalDriverDescriptor
- can be the analytical driver(Parameter) itself or its label (String)priority
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |