com.oberon.ooql.sdk
Class ObjectSpace

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

All Implemented Interfaces:

java.io.Serializable

public class ObjectSpace
extends AdminBase
implements java.io.Serializable

ObjectSpace Admin Object: defines a object container on database.

Version:

5.0

See Also:

Serialized Form

Field Summary

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

bsOptions, HIDDEN_OPTION

Constructor Summary

ObjectSpace()

ObjectSpace(java.lang.String name)

Method Summary

void	check(Framework framework) Check the if ObjectObj's data are correct
java.lang.String	compareUpdate(ObjectSpace refObjectSpace, boolean checkImage, boolean overwrite, boolean force, Framework framework) Return/apply the OOQL command to update this ObjectSpace object and let it become equals to another reference object.
void	create(boolean force, Framework framework) Create a new ObjectSpace object on the database
void	create(Framework framework) Create a new ObjectSpace object on the database
void	defrag(int commit, Framework framework)
void	destroy(Framework framework) Remove the ObjectSpace object from the database
void	empty(Framework framework) Remove (destroy) all ObjectObj instances from ObjectSpace
void	fromXML(org.jdom.Element rootElement) Load the ObjectSpace object properties from XML element tree
java.lang.String	getCreateCommand(boolean force) Return the OOQL command to create this ObjectSpace object with the settled properties
java.lang.String	getIndexSpace() Get database tablespace where index tables for all ObjectObjs belonging to this ObjectSpace are stored.
java.lang.String	getOSCode() Get the ObjectSpace cose.
int	getOSId() Get the ObjectSpace unique id.
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 ObjectSpace object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) Return the OOQL command to update this ObjectSpace object with the modified properties.
java.lang.String	getTableSpace() Get database tablespace where data tables for all ObjectObjs belonging to this ObjectSpace are stored.
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	getTotalObjects(Framework framework) Get the number of ObjectObj instances defined into this ObjectSpace
void	link(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open the ObjectSpace object: connect the memory instance with the database instance
static ObjectSpace	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
void	setIndexSpace(java.lang.String indexSpace) Set database tablespace where index tables for all ObjectObjs belonging to this ObjectSpace are stored.
void	setOSId(int objectSpaceID) Set the ObjectSpace unique id.
void	setTableSpace(java.lang.String tableSpace) Set database tablespace where data tables for all ObjectObjs belonging to this ObjectSpace are stored.
java.lang.String	toString() Return the ObjectSpace object basic properties as a single String
java.lang.String	toString(Framework framework) Return the ObjectSpace object extended properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the ObjectSpace object properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the ObjectSpace 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 ObjectSpace object to the database
void	write(Framework framework) Update the ObjectSpace 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

ObjectSpace

public ObjectSpace()

ObjectSpace

public ObjectSpace(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 ObjectSpace 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 ObjectSpace 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 ObjectSpace 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 ObjectSpace 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 ObjectSpace 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 ObjectSpace 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

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 ObjectSpace 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 or not empty space

empty

public void empty(Framework framework)
           throws OberonException

Remove (destroy) all ObjectObj instances from ObjectSpace

Parameters:

framework - the current framework

Throws:

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

check

public void check(Framework framework)
           throws OberonException

Check the if ObjectObj's data are correct

Parameters:

framework - the current framework

Throws:

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

defrag

public void defrag(int commit,
                   Framework framework)
            throws OberonException

Throws:

OberonException

setOSId

public void setOSId(int objectSpaceID)

Set the ObjectSpace unique id. [INTERNAL USAGE] The OS id is a progressive positive integer value that determines the OS code. Example: if id is equal to 5 the OS code is Z00005 All ObjectObj instances collected into this ObjectSpace will have id starting with #00005-........

getOSId

public int getOSId()

Get the ObjectSpace unique id.

See Also:

setOSId(int)

getOSCode

public java.lang.String getOSCode()

Get the ObjectSpace cose.

See Also:

setOSId(int)

setTableSpace

public void setTableSpace(java.lang.String tableSpace)

Set database tablespace where data tables for all ObjectObjs belonging to this ObjectSpace are stored.

getTableSpace

public java.lang.String getTableSpace()

Get database tablespace where data tables for all ObjectObjs belonging to this ObjectSpace are stored.

setIndexSpace

public void setIndexSpace(java.lang.String indexSpace)

Set database tablespace where index tables for all ObjectObjs belonging to this ObjectSpace are stored.

getIndexSpace

public java.lang.String getIndexSpace()

Get database tablespace where index tables for all ObjectObjs belonging to this ObjectSpace are stored.

getTotalObjects

public int getTotalObjects(Framework framework)

Get the number of ObjectObj instances defined into this ObjectSpace

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 ObjectSpace object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: tablespace , totalobjects ...)

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 ObjectSpace object basic properties as a single String

Overrides:

toString in class AdminBase

toString

public java.lang.String toString(Framework framework)

Return the ObjectSpace 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 ObjectSpace 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 ObjectSpace 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 ObjectSpace 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 ObjectSpace object with the settled properties

Specified by:

getCreateCommand in class AdminBase

Parameters:

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

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

Return the OOQL command to update this ObjectSpace 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(ObjectSpace refObjectSpace,
                                      boolean checkImage,
                                      boolean overwrite,
                                      boolean force,
                                      Framework framework)
                               throws OberonException

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

Parameters:

refObjectSpace - the reference ObjectSpace 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)