Style Intelligence v12.0

inetsoft.sree
Interface AnalyticRepository

All Superinterfaces:
Remote, RepletRepository

public interface AnalyticRepository
extends RepletRepository

This defines the server interface for the analytic component of the report server. This API is likely to change in the future.


Field Summary
static String ADD_ACTION
          Add action.
static int CHART_ELEMENT
          Chart element type.
static String DELETE_ACTION
          Delete action.
static int IMAGE_ELEMENT
          New line element type.
static String INSERT_ACTION
          Insert action.
static String LOCAL_QUERY
          Local query prefix.
static String MOVEDOWN_ACTION
          Move down action.
static String MOVEUP_ACTION
          Move up action.
static int NEWLINE_ELEMENT
          New line element type.
static int SAVE_NEW_TEMPLATE
          Saving option.
static int SAVE_OVERWRITE_REPLET
          Saving option.
static int SAVE_OVERWRITE_TEMPLATE
          Saving option.
static int SAVE_PARAMETER_ONLY
          Saving option.
static int SAVE_PORTLET
          Saving option.
static int SECTION_ELEMENT
          Section element type.
static int SEPARATOR_ELEMENT
          Separator element type.
static int TABLE_ELEMENT
          Table element type.
static int TEXT_ELEMENT
          Text element type.
static int TEXTBOX_ELEMENT
          Text element type.
 
Fields inherited from interface inetsoft.sree.RepletRepository
ADDTOQ_FAILURE, ADDTOQ_GENERATION, ADDTOQ_SUCCESS, AUTO_REPLET, DEFAULT_ARCHIVE, NO_ARCHIVE, NOT_CHECK_PERMISSION, PREGENERATE, PRINCIPAL_COOKIE, REPLET, REPLET_MASK, REPORT, VERSIONED_ARCHIVE, VIRTUAL_REPLET
 
Method Summary
 void changeElement(String action, int elementType, String elementID, Object rid)
          Change element.
 void generateReplet2(Object repletId, RepletRequest request, int mode)
          Generate a report from the specified replet instance.
 String[] getDataModelNames()
          Get the names of all logi models available.
 inetsoft.report.internal.info.ElementInfo getElementInfo(String elementID, Object rid, Principal user)
          Get elements list of an composed report object.
 inetsoft.sree.internal.ElementIdentity[] getElementList(Object rid, boolean vis)
          Get elements list of an composed report object.
 String[] getElementQueries(Object rid)
          Get element queries of a report.
 XLogicalModel getLogicalModel(String name, Principal principal)
          Get a data model with the specified name.
 Serializable getObject(String op, Object rid, String eid)
          Get a serializable Object from engine.
 RepositoryEntry[] getPrototypes()
          Get the prototypes registered in this repository.
 XQuery getQuery(String name, Object rid)
          Get a query with the specified name.
 inetsoft.report.internal.binding.Field[] getQueryMetaData(String qname, int type, Object rid, Principal user)
          Get query metadata for a query.
 String[] getQueryNames(Principal principal, Object rid)
          Get query name list.
 Serializable getSourceTreeModel(Object rid, String eid, Principal principal, Serializable opens, Serializable selected)
          Get source tree model from engine.
 inetsoft.util.XMLSerializable getTableStyles()
          Get a list of current usable table style.
 boolean save(Principal principal, Object rid, String name, String alias, String description, String layout, int saveOptions, boolean ownPermission)
          Save the replet as another name and another location.
 void setElementInfo(inetsoft.report.internal.info.ElementInfo info, String elementID, Object rid)
          Get elements list of an composed report object.
 void setObject(String op, Object rid, String eid, Serializable obj)
          Set a serializable Object to engine.
 
Methods inherited from interface inetsoft.sree.RepletRepository
addFolder, addToQueue, authenticate, cancel, changeFolder, changePassword, checkPermission, containsFolder, containsParameterSheet, createReplet, createThumbnail, destroy, disableParameterSheet, export, find, generateReplet, getActiveReplets, getArchiveOption, getArchiveReplets, getArchiveReport, getEventHandler, getEventMask, getFolders, getHeadingTargets, getPage, getPageCount, getPageLocation, getPrinters, getPrintPages, getProcessStatus, getProperty, getQueuedReplets, getRegisteredSelections, getRepletContext, getRepletParameters, getReplets, getReportProperty, getReportSize, getRepositoryEntries, getResourceLength, getScheduleTask, getScheduleTasks, getSingleStylePage, handleEvent, isFolderChanged, isParameterSheet, logout, mailTo, mailTo, mailTo, mailTo, mailTo, nextBlock, print, removeFromQueue, removeRepositoryEntry, removeScheduleTask, renameRepositoryEntry, resetReplet, saveInArchive, setPermission, setScheduleTask
 

Field Detail

TEXT_ELEMENT

static final int TEXT_ELEMENT
Text element type.

See Also:
Constant Field Values

TEXTBOX_ELEMENT

static final int TEXTBOX_ELEMENT
Text element type.

See Also:
Constant Field Values

TABLE_ELEMENT

static final int TABLE_ELEMENT
Table element type.

See Also:
Constant Field Values

CHART_ELEMENT

static final int CHART_ELEMENT
Chart element type.

See Also:
Constant Field Values

SECTION_ELEMENT

static final int SECTION_ELEMENT
Section element type.

See Also:
Constant Field Values

SEPARATOR_ELEMENT

static final int SEPARATOR_ELEMENT
Separator element type.

See Also:
Constant Field Values

NEWLINE_ELEMENT

static final int NEWLINE_ELEMENT
New line element type.

See Also:
Constant Field Values

IMAGE_ELEMENT

static final int IMAGE_ELEMENT
New line element type.

See Also:
Constant Field Values

ADD_ACTION

static final String ADD_ACTION
Add action.

See Also:
Constant Field Values

DELETE_ACTION

static final String DELETE_ACTION
Delete action.

See Also:
Constant Field Values

MOVEUP_ACTION

static final String MOVEUP_ACTION
Move up action.

See Also:
Constant Field Values

MOVEDOWN_ACTION

static final String MOVEDOWN_ACTION
Move down action.

See Also:
Constant Field Values

INSERT_ACTION

static final String INSERT_ACTION
Insert action.

See Also:
Constant Field Values

LOCAL_QUERY

static final String LOCAL_QUERY
Local query prefix.

See Also:
Constant Field Values

SAVE_NEW_TEMPLATE

static final int SAVE_NEW_TEMPLATE
Saving option. Create a copy of the SRT file for the new replet entry.

See Also:
Constant Field Values

SAVE_OVERWRITE_REPLET

static final int SAVE_OVERWRITE_REPLET
Saving option. Overwrite the original replet.

See Also:
Constant Field Values

SAVE_OVERWRITE_TEMPLATE

static final int SAVE_OVERWRITE_TEMPLATE
Saving option. Overwrite the original SRT file with the replet.

See Also:
Constant Field Values

SAVE_PARAMETER_ONLY

static final int SAVE_PARAMETER_ONLY
Saving option. Save the parameters in a new entry but point to the same SRT.

See Also:
Constant Field Values

SAVE_PORTLET

static final int SAVE_PORTLET
Saving option. Register the report as a portlet.

See Also:
Constant Field Values
Method Detail

generateReplet2

void generateReplet2(Object repletId,
                     RepletRequest request,
                     int mode)
                     throws RepletException,
                            RemoteException
Generate a report from the specified replet instance. The createReplet method must be called before calling this method.

Parameters:
repletId - the replet instance ID returned from createReplet.
request - a RepletRequest object containing the report parameters. If this argument is null, the report is generated using the last request.
mode - the specified report mode defined in BasicReplet.
Throws:
RepletException - if an error occurs that prevents the report from being generated.
RemoteException - if some unspecified error occurs during generation.

getPrototypes

RepositoryEntry[] getPrototypes()
                                throws RemoteException
Get the prototypes registered in this repository.

Returns:
a list of the registered prototypes.
Throws:
RemoteException

getElementQueries

String[] getElementQueries(Object rid)
                           throws RemoteException
Get element queries of a report.

Parameters:
rid - the specified replet id.
Returns:
element queries of the specified report, and its format is element::elementid or element::elementid[rotated].
Throws:
RemoteException

getQueryNames

String[] getQueryNames(Principal principal,
                       Object rid)
                       throws RemoteException
Get query name list.

Parameters:
principal - represents an entity.
Throws:
RemoteException

getQueryMetaData

inetsoft.report.internal.binding.Field[] getQueryMetaData(String qname,
                                                          int type,
                                                          Object rid,
                                                          Principal user)
                                                          throws RemoteException
Get query metadata for a query.

Throws:
RemoteException

getDataModelNames

String[] getDataModelNames()
                           throws RemoteException
Get the names of all logi models available.

Returns:
the names of the data models.
Throws:
RemoteException

getQuery

XQuery getQuery(String name,
                Object rid)
                throws RemoteException
Get a query with the specified name.

Parameters:
name - the name of the query.
rid - the report if getting embedded queries.
Returns:
the requested query.
Throws:
RemoteException - if an error occurs.

getLogicalModel

XLogicalModel getLogicalModel(String name,
                              Principal principal)
                              throws RemoteException
Get a data model with the specified name. The actual data model returned may be a virtual private model that provides a view to the data model for the assigned roles.

Parameters:
name - the name of the data model.
principal - the roles assigned to the user that is requesting the data model.
Returns:
the requested data model.
Throws:
RemoteException - if an error occurs.

getTableStyles

inetsoft.util.XMLSerializable getTableStyles()
                                             throws RemoteException
Get a list of current usable table style.

Returns:
available table styles.
Throws:
RemoteException

getElementList

inetsoft.sree.internal.ElementIdentity[] getElementList(Object rid,
                                                        boolean vis)
                                                        throws RemoteException
Get elements list of an composed report object.

Parameters:
rid - the replet instance ID.
vis - if true only get visible elements.
Returns:
an array of element identity objects.
Throws:
RemoteException

getElementInfo

inetsoft.report.internal.info.ElementInfo getElementInfo(String elementID,
                                                         Object rid,
                                                         Principal user)
                                                         throws RemoteException
Get elements list of an composed report object.

Parameters:
rid - the replet instance ID.
elementID - the elementID.
user - the user.
Returns:
an element Info object.
Throws:
RemoteException

getSourceTreeModel

Serializable getSourceTreeModel(Object rid,
                                String eid,
                                Principal principal,
                                Serializable opens,
                                Serializable selected)
                                throws RemoteException
Get source tree model from engine.

Parameters:
rid - the specified replet id.
eid - the specified element id.
opens - the opened source entries.
selected - the source attr.
Throws:
RemoteException

getObject

Serializable getObject(String op,
                       Object rid,
                       String eid)
                       throws RemoteException
Get a serializable Object from engine.

Parameters:
op - the specified operation to process.
rid - the specified replet id.
eid - the specified element id.
Returns:
a serializable Object.
Throws:
RemoteException

setElementInfo

void setElementInfo(inetsoft.report.internal.info.ElementInfo info,
                    String elementID,
                    Object rid)
                    throws RemoteException
Get elements list of an composed report object.

Parameters:
info - element Info object.
elementID - the replet instance ID.
Throws:
RemoteException

setObject

void setObject(String op,
               Object rid,
               String eid,
               Serializable obj)
               throws RemoteException
Set a serializable Object to engine.

Parameters:
op - the specified operation to process.
rid - the specified replet id.
eid - the specified element id.
obj - the specified serializable Object.
Throws:
RemoteException

changeElement

void changeElement(String action,
                   int elementType,
                   String elementID,
                   Object rid)
                   throws RemoteException
Change element.

Parameters:
action - the specified action which is one of the actions predefined in AnalyticRepository.
elementType - the speciefied element type.
rid - the specified report instance ID.
elementID - the specified elementID.
Throws:
RemoteException

save

boolean save(Principal principal,
             Object rid,
             String name,
             String alias,
             String description,
             String layout,
             int saveOptions,
             boolean ownPermission)
             throws RemoteException
Save the replet as another name and another location.

Parameters:
rid - the replet instance ID.
Returns:
true if the file is saved successfully
Throws:
RemoteException

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.