OBEROn - OOQL Language

home

project

documentation

support

applications

downloads

contacts

objectspace

object container on database

define - create new objectspace definition

  objectspace define AdminName tablespace AdminName {ObjectSpace_DefineOption} [force];

clone - duplicate an objectspace and set the properties for the new instance

  objectspace clone AdminName define AdminName {ObjectSpace_EditOption} [force];

edit - update the objectspace properties

  objectspace edit AdminName {ObjectSpace_EditOption} [force];

show - print the objectspace properties

  objectspace show AdminName [ObjectSpace_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract objectspaces on the base of query filters

  objectspace select AdminPatternList {Filter_Option} [ObjectSpace_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

check - check the if objects inside the objectspace are correct [not yet supported]

  objectspace check AdminName ;

empty- remove (destroy) all object/link instances from the objectspace (fails if some objects have revisions                  in other objectspaces: in this case you have to move all revisions to the same space before)

  objectspace empty AdminName ;

undefine - remove an empty objectspace from the database

  objectspace undefine AdminName ;

ObjectSpace_DefineOption
	description GenericValue
	application AdminName
	image FileName
	imagedata GenericString
	indexspace AdminName
	[! /not] hidden

ObjectSpace_EditOption
	name AdminName
	description GenericValue
	application AdminName
	svnrev NUMBER
	image FileName
	imagedata GenericString
	[! /not] hidden

ObjectSpace_GetOption
	get [ObjectSpace_GetBasicOption]

	ObjectSpace_GetBasicOption
		{ ObjectSpace_GetBasicToken [as IDENTIFIER] { ObjectSpace_GetBasicToken [as IDENTIFIER] } }
		ObjectSpace_GetBasicToken [as IDENTIFIER]

		ObjectSpace_GetBasicToken
			Common_GetBasicOption
			tablespace
			indexspace
			totalobjects

KEYWORDs
	application	the associated application menu
	description	the objectspace description
	force	this flag allows to ignore errors during the creation/update
	hidden	administration hidden objects are not visible/usable
	image	local path for the objectspace icon to upload
	imagedata	base64 code for the objectspace icon
	indexspace	the tablespace inside the DB where the objectspace related indexes are created
	moddate	last modification date
	name	the objectspace name
	svnrev	SVN repository revision number
	tablespace	the tablespace inside the DB where the objectspace related tables are created
	totalobjects	number of objects collected into the objectspace

SAMPLES

objectspace define "OS0" description 'My Object Space 0' image "C:\images\img25.gif" tablespace TEST indexspace INDEXTEST;

objectspace clone "OS0" define "OS1" description 'MY OS1' image"C:\images\img30.gif";

objectspace edit OS1 description 'My Object Space 1' hidden;

objectspace show 'OS1' get { name image tablespace indexspace } token "|" ;

objectspace select OS* get { name description hidden indexspace totalobjects } token xml ;

Common_GetBasicOption
	Common_GetBasicToken [ as IDENTIFIER ]

Common_GetBasicToken
	id
	name
	origdate
	moddate
	moduser
	description
	svnrev
	hidden
	image
	imagedata
	feature[ AdminName ]	[. Feature_GetBasicOption]
	feature[]	[. Feature_GetBasicOption]
	feature	[. Feature_GetBasicOption]
	application	[. Menu_GetBasicOption]
	super
	admintype

Edit_Operator
	add
	remove

Edit_RefOperator
	addbefore AdminName set
	addafter AdminName set
	add
	remove
	movebefore
	moveafter

Edit_AddOperator
	addbefore AdminName define
	addafter AdminName define
	append

Edit_MoveOperator
	movebefore
	moveafter

Event_Type
	action
	check

AdminPatternList
	AdminNamePattern {, AdminNamePattern}

AdminNamePattern
	*
	PATTERNIDENTIFIER
	STRINGVAL
	AdminName

GenericPatternList
	GenericPattern {, GenericPattern}

GenericPattern
	*
	IDENTIFIER
	PATTERNIDENTIFIER
	GenericValue

AdminActor
	user AdminName
	team AdminName
	assignment AdminName

AdminName
	IDENTIFIER
	QUOTED_STRING
	SQUOTED_STRING

GenericValue
	DATETIME
	GenericNumber
	GenericString
	BOOLEANVAL

GenericString
	STRINGVAL
	QUOTED_STRING
	SQUOTED_STRING

GenericNumber
	NUMBER
	REALNUMBER

Filter_Option
	moddate Date_Range
	application AdminNamePattern

Date_Range
	= DATETIME
	!= DATETIME
	< DATETIME
	> DATETIME
	<= DATETIME
	>= DATETIME
	in [ DATETIME , DATETIME ]
	in ( DATETIME , DATETIME ]
	in [ DATETIME , DATETIME )
	in ( DATETIME , DATETIME )

Token_Option
	token { Token_Separator { Token_Separator } }
	token Token_Separator

Token_Separator
	QUOTED_STRING
	SQUOTED_STRING
	IDENTIFIER
	STRINGVAL
	json
	json-
	json+
	xml
	xml-
	xml+

ExportFile_Option
	exportfile FileName [append] [xml \| json ]

ImportFile_Option
	importfile FileName [xml \| json \|emxxml]

LogFile_Option
	logfile FileName [append]

FileName
	QUOTED_STRING
	SQUOTED_STRING

grammar rules
[ ]	= optional element - only one item is allowed : ( 0 or 1 )
{ }	= optional element - more than one is allowed : ( 0 or N )
/	= alternative
	= one of ...

	all bold texts represent keywords or command syntax

IDVAL
	#<5 dec digits [ 0-9 ]>-<8 hex digits [ 0-9 A-F ]>
	example: #00020-34F2A80E

COMMENT
	// <any character until the end of the line(\n \r)>
	example: // My single line comment

LONGCOMMENT
	/* <any character> */
	example: /* My multi line comment starts here continue here and finish here */

DATETIME
	<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits>
	examples: 2009-12-23 2009/03/19 2009.11.14
	<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits> <hours>:<minutes>:[<seconds>]
	examples: 2009-12-23 10:23 2009/03/19 16:03:34 2009.11.14 00:20:04

NUMBER
	[+-]<decimal digits [ 0-9 ]>
	examples: -1203 +276 25

BOOLEANVAL
	true / false

REALNUMBER
	[+-]<decimal digits [ 0-9 ]>.<decimal digits [ 0-9 ]>[E(+-)<esponent [0-9]>]
	example: -37.837 +2.3874 13.887 1.4862E-04

QUOTED_STRING
	"<any character>"
	example: "my quoted string"

SQUOTED_STRING
	'<any character>'
	example: 'my single quoted string'

IDENTIFIER
	<one or more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
	example: Var1 object_Name_02

VARIABLE
	$<one o more of [ a-z A-Z 0-9 ]><zero or more of [ a-z A-Z 0-9 _ ]>
	example: $1 $var_02 $1b

STRINGVAL
	<one or more of [ a-z A-Z 0-9 -_ $ ? @ \| ~ % & / = : + \ # ' ]>
	a string not recognized as identifier

PATTERNIDENTIFIER
	<a string with * (match 0 or more characters) and ? (match 1 character) wildcards>
	example: mypaer?_ide?ti