ReportEngine

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> dghda >> [ kent overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.dghda.kent.ReportEngine

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.dghda.kent
Class ReportEngine

java.lang.Object
  com.dghda.kent.ReportEngine

public class ReportEngine
extends java.lang.Object

The report engine manages the available reports, actions and transforms.

Field Summary

static java.lang.String CONFIG_DTD
          The DTD that defines configuration options.

static java.lang.String CONFIG_SPEC_END
          The end of a config spec.

static java.lang.String CONFIG_SPEC_START
          The preamble of a config spec.

static java.lang.String EMPTY_CONFIG
          An empty config spec.

private com.dghda.module.ModuleLoader m_ActionLoader


private AuthorisationManager m_Authorisation


private ReportEnvironment m_Environment


private com.dghda.module.ModuleLoader m_ReportLoader


private com.dghda.module.ModuleLoader m_TransformLoader


static int SELECT_STYLE_CHECK
          A check-box type select.

static int SELECT_STYLE_COMBO
          A combo-box type select.

static int SELECT_STYLE_RADIO
          A radio-button type select.

Constructor Summary

ReportEngine(AuthorisationManager auth, ReportEnvironment env)
          Create a new report engine, using the given report & DTD path(s).

Method Summary

boolean addAction(ReportAction action)
          Adds the given action.

static void addOptionTag(java.lang.StringBuffer buffer, java.lang.String id, java.lang.String label, boolean selected, boolean enabled, int indent)
          Add an option tag.

boolean addReport(Report report)
          Adds the given report.

boolean addTransform(ReportTransform transform)
          Adds the given transform.

boolean canAccessModule(com.dghda.module.Module module, java.lang.String user)
          Returns true if the given user is allowed to access the given module.

java.lang.String createModuleSelect(java.util.List modules, java.lang.String id, int style, java.lang.String label, int indent)
          Returns a configuration option fragment to select from the given modules.

ReportAction getAction(java.lang.String id, java.lang.String user)
          Returns the given action.

java.util.List getAvailableActions(java.lang.String user)
          Returns a list of all actions available to the given user.

protected java.util.List getAvailableModules(com.dghda.module.ModuleLoader loader, java.lang.String user)
          Returns a list of all modules available to the given user.

java.util.List getAvailableReports(java.lang.String user)
          Returns a list of all reports available to the given user.

java.util.List getAvailableTransforms(java.lang.String user)
          Returns a list of all transforms available to the given user.

java.lang.String getDTDPath(java.lang.String dtd)
          Returns the path to the given DTD.

ReportEnvironment getEnvironment()
          Returns the environment object.

java.lang.String getProperty(java.lang.String property)
          Returns the value of the given property, or null if it is not set.

Report getReport(java.lang.String id, java.lang.String user)
          Returns the given report.

java.io.InputStream getResource(java.lang.String path)
          Accesses the given resource.

ReportTransform getTransform(java.lang.String id, java.lang.String user)
          Returns the given transform.

static void openSelectTag(java.lang.StringBuffer buffer, java.lang.String id, int style, java.lang.String label, boolean enabled, int indent)
          Open a select tag.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_DTD

public static final java.lang.String CONFIG_DTD

The DTD that defines configuration options.

See Also:: Constant Field Values

CONFIG_SPEC_START

public static final java.lang.String CONFIG_SPEC_START

The preamble of a config spec.

See Also:: Constant Field Values

CONFIG_SPEC_END

public static final java.lang.String CONFIG_SPEC_END

The end of a config spec.

See Also:: Constant Field Values

EMPTY_CONFIG

public static final java.lang.String EMPTY_CONFIG

An empty config spec.

See Also:: Constant Field Values

SELECT_STYLE_RADIO

public static final int SELECT_STYLE_RADIO

A radio-button type select.

See Also:: Constant Field Values

SELECT_STYLE_CHECK

public static final int SELECT_STYLE_CHECK

A check-box type select.

See Also:: Constant Field Values

SELECT_STYLE_COMBO

public static final int SELECT_STYLE_COMBO

A combo-box type select.

See Also:: Constant Field Values

m_Authorisation

private AuthorisationManager m_Authorisation

m_Environment

private ReportEnvironment m_Environment

m_ReportLoader

private com.dghda.module.ModuleLoader m_ReportLoader

m_ActionLoader

private com.dghda.module.ModuleLoader m_ActionLoader

m_TransformLoader

private com.dghda.module.ModuleLoader m_TransformLoader

Constructor Detail

ReportEngine

public ReportEngine(AuthorisationManager auth,
                    ReportEnvironment env)
             throws EngineInitialisationException

Create a new report engine, using the given report & DTD path(s).

Method Detail

getAvailableReports

public java.util.List getAvailableReports(java.lang.String user)

Returns a list of all reports available to the given user.

getAvailableActions

public java.util.List getAvailableActions(java.lang.String user)

Returns a list of all actions available to the given user.

getAvailableTransforms

public java.util.List getAvailableTransforms(java.lang.String user)

Returns a list of all transforms available to the given user.

getReport

public Report getReport(java.lang.String id,
                        java.lang.String user)

Returns the given report.

getAction

public ReportAction getAction(java.lang.String id,
                              java.lang.String user)

Returns the given action.

getTransform

public ReportTransform getTransform(java.lang.String id,
                                    java.lang.String user)

Returns the given transform.

addReport

public boolean addReport(Report report)

Adds the given report.

addAction

public boolean addAction(ReportAction action)

Adds the given action.

addTransform

public boolean addTransform(ReportTransform transform)

Adds the given transform.

getDTDPath

public java.lang.String getDTDPath(java.lang.String dtd)

Returns the path to the given DTD. Just prepends the DTD base path to the DTD file name given.

getProperty

public java.lang.String getProperty(java.lang.String property)

Returns the value of the given property, or null if it is not set.

getResource

public java.io.InputStream getResource(java.lang.String path)
                                throws java.io.IOException

Accesses the given resource.

getEnvironment

public ReportEnvironment getEnvironment()

Returns the environment object.

canAccessModule

public boolean canAccessModule(com.dghda.module.Module module,
                               java.lang.String user)

Returns true if the given user is allowed to access the given module.

createModuleSelect

public java.lang.String createModuleSelect(java.util.List modules,
                                           java.lang.String id,
                                           int style,
                                           java.lang.String label,
                                           int indent)

Returns a configuration option fragment to select from the given modules.

openSelectTag

public static void openSelectTag(java.lang.StringBuffer buffer,
                                 java.lang.String id,
                                 int style,
                                 java.lang.String label,
                                 boolean enabled,
                                 int indent)

Open a select tag.

addOptionTag

public static void addOptionTag(java.lang.StringBuffer buffer,
                                java.lang.String id,
                                java.lang.String label,
                                boolean selected,
                                boolean enabled,
                                int indent)

Add an option tag.

getAvailableModules

protected java.util.List getAvailableModules(com.dghda.module.ModuleLoader loader,
                                             java.lang.String user)

Returns a list of all modules available to the given user.

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> dghda >> [ kent overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`static java.lang.String`	`CONFIG_DTD` The DTD that defines configuration options.
`static java.lang.String`	`CONFIG_SPEC_END` The end of a config spec.
`static java.lang.String`	`CONFIG_SPEC_START` The preamble of a config spec.
`static java.lang.String`	`EMPTY_CONFIG` An empty config spec.
`private com.dghda.module.ModuleLoader`	`m_ActionLoader`
`private AuthorisationManager`	`m_Authorisation`
`private ReportEnvironment`	`m_Environment`
`private com.dghda.module.ModuleLoader`	`m_ReportLoader`
`private com.dghda.module.ModuleLoader`	`m_TransformLoader`
`static int`	`SELECT_STYLE_CHECK` A check-box type select.
`static int`	`SELECT_STYLE_COMBO` A combo-box type select.
`static int`	`SELECT_STYLE_RADIO` A radio-button type select.

Constructor Summary
`ReportEngine(AuthorisationManager auth, ReportEnvironment env)` Create a new report engine, using the given report & DTD path(s).

Method Summary
`boolean`	`addAction(ReportAction action)` Adds the given action.
`static void`	`addOptionTag(java.lang.StringBuffer buffer, java.lang.String id, java.lang.String label, boolean selected, boolean enabled, int indent)` Add an option tag.
`boolean`	`addReport(Report report)` Adds the given report.
`boolean`	`addTransform(ReportTransform transform)` Adds the given transform.
`boolean`	`canAccessModule(com.dghda.module.Module module, java.lang.String user)` Returns true if the given user is allowed to access the given module.
`java.lang.String`	`createModuleSelect(java.util.List modules, java.lang.String id, int style, java.lang.String label, int indent)` Returns a configuration option fragment to select from the given modules.
`ReportAction`	`getAction(java.lang.String id, java.lang.String user)` Returns the given action.
`java.util.List`	`getAvailableActions(java.lang.String user)` Returns a list of all actions available to the given user.
`protected java.util.List`	`getAvailableModules(com.dghda.module.ModuleLoader loader, java.lang.String user)` Returns a list of all modules available to the given user.
`java.util.List`	`getAvailableReports(java.lang.String user)` Returns a list of all reports available to the given user.
`java.util.List`	`getAvailableTransforms(java.lang.String user)` Returns a list of all transforms available to the given user.
`java.lang.String`	`getDTDPath(java.lang.String dtd)` Returns the path to the given DTD.
`ReportEnvironment`	`getEnvironment()` Returns the environment object.
`java.lang.String`	`getProperty(java.lang.String property)` Returns the value of the given property, or null if it is not set.
`Report`	`getReport(java.lang.String id, java.lang.String user)` Returns the given report.
`java.io.InputStream`	`getResource(java.lang.String path)` Accesses the given resource.
`ReportTransform`	`getTransform(java.lang.String id, java.lang.String user)` Returns the given transform.
`static void`	`openSelectTag(java.lang.StringBuffer buffer, java.lang.String id, int style, java.lang.String label, boolean enabled, int indent)` Open a select tag.

com.dghda.kent Class ReportEngine

CONFIG_DTD

CONFIG_SPEC_START

CONFIG_SPEC_END

EMPTY_CONFIG

SELECT_STYLE_RADIO

SELECT_STYLE_CHECK

SELECT_STYLE_COMBO

m_Authorisation

m_Environment

m_ReportLoader

m_ActionLoader

m_TransformLoader

ReportEngine

getAvailableReports

getAvailableActions

getAvailableTransforms

getReport

getAction

getTransform

addReport

addAction

addTransform

getDTDPath

getProperty

getResource

getEnvironment

canAccessModule

createModuleSelect

openSelectTag

addOptionTag

getAvailableModules

com.dghda.kent
Class ReportEngine