com.oberon.ooql.sdk
Class Graph

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminBase
          com.oberon.ooql.sdk.Graph

All Implemented Interfaces:

java.io.Serializable

public class Graph
extends AdminBase
implements java.io.Serializable

Graph Admin Object: generates chart images for application usage

Version:

5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.oberon.ooql.sdk.AdminBase

bsOptions, HIDDEN_OPTION

Constructor Summary

Graph()

Graph(java.lang.String name)

Method Summary

java.lang.String	compareSimple(Graph refGraph, boolean checkImage) Return the template of OOQL command to update this Graph object and let it become equals to another reference object.
java.lang.String	compareUpdate(Graph refGraph, boolean checkImage, boolean overwrite, boolean force, Framework framework) Return/apply the OOQL command to update this Graph object and let it become equals to another reference object.
void	create(boolean force, Framework framework) Create a new Graph object on the database
void	create(Framework framework) Create a new Graph object on the database
void	destroy(Framework framework) Remove the Graph object from the database
byte[]	draw(GraphValues values, Framework framework) Generates a chart image based on the Graph style parameters and input data values
static byte[]	drawGraph(java.lang.String graphName, java.lang.String XMLvalues, Framework framework) Generates a chart image based on the Graph style parameters and input data values
void	fromXML(org.jdom.Element rootElement) Load the Graph object properties from XML element tree
java.lang.String	getCreateCommand(boolean force) Return the OOQL command to create this Graph object with the settled properties
java.lang.String	getCreateCommand(boolean force, boolean simple) Return the OOQL command to create this Graph object with the settled properties
int	getHeight() Get the Graph height
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this Graph object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) Return the OOQL command to update this Graph object with the modified properties.
java.lang.String	getStyle() Get the Graph style as XML String
GraphStyler	getStyler() Get the Graph styler containing the chart parameters
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
int	getType() Get the Graph type
java.lang.String	getTypeAsString() Get the Graph type as String
int	getWidth() Get the Graph width
void	link(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open the Graph object: connect the memory instance with the database instance
static Graph	open(java.lang.String name, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open an administrative object and read properties from the database or retrieve them from memory
byte[]	preview(Framework framework) Generates a preview image based on the Graph style parameters
void	setStyle(GraphStyler graphStyler) Set the Graph style
void	setStyle(java.lang.String xmlStyle) Set the Graph style
void	setStyleFile(java.lang.String filePath) Set the Graph style from an XML file
void	setType(int type) Set the Graph type
java.lang.String	toString() Return the Graph object basic properties as a single String
java.lang.String	toString(Framework framework) Return the Graph object extended properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the Graph object properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the Graph object properties as XML element tree
void	unlink(Framework framework) Close the object: disconnect the memory instance from the database instance
void	write(boolean force, Framework framework) Update the Graph object to the database
void	write(Framework framework) Update the Graph object to the database

Methods inherited from class com.oberon.ooql.sdk.AdminBase

addFeature, changedApplication, checkChangeName, checkCounters, checkCounters, getAdminType, getApplication, getCommonProperty, getCommonTargetNames, getCounters, getCreateBasicCommand, getCreateCommand, getCrtDate, getDescription, getEditBasicCommand, getFeature, getFeatures, getFeaturesAsString, getImage, getImage, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, getPlainFeatures, getSaveCommand, getSVNRevision, getXMLFeatureList, hasImage, isHidden, setApplication, setCounters, setCrtDate, setDescription, setHidden, setImage, setImageData, setImageFile, setModDate, setModUser, setName, setSVNRevision, show, show, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Graph

public Graph()

Graph

public Graph(java.lang.String name)
      throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

open

public static Graph open(java.lang.String name,
                         Framework framework,
                         java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
                  throws OberonException

Open an administrative object and read properties from the database or retrieve them from memory

Parameters:

name - the object name

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

link

public void link(Framework framework,
                 java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
          throws OberonException

Open the Graph object: connect the memory instance with the database instance

Specified by:

link in class AdminBase

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

create

public void create(Framework framework)
            throws OberonException

Create a new Graph object on the database

Specified by:

create in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

create

public void create(boolean force,
                   Framework framework)
            throws OberonException

Create a new Graph object on the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

write

public void write(Framework framework)
           throws OberonException

Update the Graph object to the database

Specified by:

write in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

write

public void write(boolean force,
                  Framework framework)
           throws OberonException

Update the Graph object to the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

preview

public byte[] preview(Framework framework)
               throws OberonException

Generates a preview image based on the Graph style parameters

Returns:

the chart image

Throws:

OberonException

draw

public byte[] draw(GraphValues values,
                   Framework framework)
            throws OberonException

Generates a chart image based on the Graph style parameters and input data values

Returns:

the chart image

Throws:

OberonException

unlink

public void unlink(Framework framework)
            throws OberonException

Close the object: disconnect the memory instance from the database instance

Specified by:

unlink in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions

destroy

public void destroy(Framework framework)
             throws OberonException

Remove the Graph object from the database

Specified by:

destroy in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

drawGraph

public static byte[] drawGraph(java.lang.String graphName,
                               java.lang.String XMLvalues,
                               Framework framework)
                        throws java.lang.Exception

Generates a chart image based on the Graph style parameters and input data values

Parameters:

graphName - the Graph name

XMLvalues - input data values in XML format (see GraphValues)

framework - the current framework

Returns:

the chart image

Throws:

java.lang.Exception

setType

public void setType(int type)

Set the Graph type

Parameters:

type - the chart type; see the GraphStyler TYPE constants

getType

public int getType()

Get the Graph type

getTypeAsString

public java.lang.String getTypeAsString()

Get the Graph type as String

getWidth

public int getWidth()

Get the Graph width

getHeight

public int getHeight()

Get the Graph height

setStyle

public void setStyle(GraphStyler graphStyler)

Set the Graph style

Parameters:

graphStyler - the GraphStyler containing the chart parameters

setStyle

public void setStyle(java.lang.String xmlStyle)

Set the Graph style

Parameters:

xmlStyle - the XML String representing the chart parameters

setStyleFile

public void setStyleFile(java.lang.String filePath)
                  throws OberonException

Set the Graph style from an XML file

Parameters:

filePath - the XML file path/name representing the chart parameters

Throws:

OberonException

getStyle

public java.lang.String getStyle()

Get the Graph style as XML String

getStyler

public GraphStyler getStyler()

Get the Graph styler containing the chart parameters

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this Graph object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: type , style ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the Graph object basic properties as a single String

Overrides:

toString in class AdminBase

toString

public java.lang.String toString(Framework framework)

Return the Graph object extended properties as a single String

Overrides:

toString in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(Framework framework)

Return the Graph object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the Graph object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the Graph object properties from XML element tree

Overrides:

fromXML in class AdminBase

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

Return the OOQL command to create this Graph object with the settled properties

Specified by:

getCreateCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

getCreateCommand

public java.lang.String getCreateCommand(boolean force,
                                         boolean simple)

Return the OOQL command to create this Graph object with the settled properties

Parameters:

simple - if true return the command template

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

Return the OOQL command to update this Graph object with the modified properties.
If the object is new, it returns the create command.

Specified by:

getSaveCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

compareUpdate

public java.lang.String compareUpdate(Graph refGraph,
                                      boolean checkImage,
                                      boolean overwrite,
                                      boolean force,
                                      Framework framework)
                               throws OberonException

Return/apply the OOQL command to update this Graph object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refGraph - the reference Graph object

checkImage - if true compare also the image icon

overwrite - if true update the database object instance

force - if true ignores optional properties

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)

compareSimple

public java.lang.String compareSimple(Graph refGraph,
                                      boolean checkImage)
                               throws OberonException

Return the template of OOQL command to update this Graph object and let it become equals to another reference object.

Parameters:

refGraph - the reference Graph object

checkImage - if true compare also the image icon

Throws:

OberonException