OOQL language autonumber

progressive object name generator


define - create new autonumber definition

  autonumber define   AdminName class  AdminName {AutoNumber_DefineOption} [force];

clone - duplicate a autonumber and set the properties for the new instance

  autonumber clone  AdminName define AdminName {AutoNumber_EditOption} [force];

edit - update the autonumber properties

  autonumber edit   AdminName {AutoNumber_EditOption} [force];

show - print the autonumber properties

  autonumber show   AdminName [AutoNumber_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract autonumbers on the base of query filters

  autonumber select AdminPatternList {Filter_Option} [AutoNumber_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

increment - increase the autonumber counter

  autonumber increase
AdminName [value NUMBER] ;

undefine - remove a autonumber from the database

  autonumber undefine AdminName ;


AutoNumber_DefineOption
description GenericValue
application AdminName
image  FileName
imagedata GenericString
sequence GenericValue
format GenericValue
nextvalue GenericValue
lifecycle AdminName
objectspace AdminName
program AdminName
[! /not] hidden

AutoNumber_EditOption
name AdminName
description GenericValue
application AdminName
svnrev NUMBER
image  FileName
imagedata GenericString
class AdminName
sequence GenericValue
format GenericValue
nextvalue GenericValue
lifecycle AdminName
objectspace AdminName
program AdminName
[! /not] hidden

AutoNumber_GetOption
get [AutoNumber_GetBasicOption]
   
  AutoNumber_GetBasicOption
  { AutoNumber_GetBasicToken [as IDENTIFIER] { AutoNumber_GetBasicToken [as IDENTIFIER] } }
  AutoNumber_GetBasicToken [as IDENTIFIER]
     
    AutoNumber_GetBasicToken
    Common_GetBasicOption  
    sequence  
    format  
    nextvalue  
    class [. Class_GetBasicOption]
    lifecycle [. Lifecycle_GetBasicOption]
    objectspace [. ObjectSpace_GetBasicOption]
    program [. Program_GetBasicOption]


KEYWORDs
application the associated application menu
class the class for the generated object istance
description the autonumber description
format format of the generated object name ( must include the <COUNTER> tag )
force this flag allows to ignore errors during the creation/update (for example, class, lifecycle, objectspace not yet defined)
hidden administration hidden objects are not visible/usable
image local path for the autonumber icon to upload
imagedata base64 code for the autonumber icon
lifecycle the lifecycle assigned to the generated object istance
moddate last modification date
name the autonumber name
nextvalue the name that will be assigned to the next generated object
objectspace the objectspace where the generated object instances will be stored
program program used to generate the object names
sequence the counter sequence definition [positional digits]
svnrev SVN repository revision number


SAMPLES


autonumber define AN01 class CL01 sequence "{X 9X.O}" nextvalue "[E 4F.ONE]" format "SX-<COUNTER>/40" lifecycle 'LC05' objectspace OS10 ;

autonumber define AN02 class MC_Cappe sequence "{X 9X.O}" ;

autonumber clone AN02 define AN03 class CL05 program "Increase AN02";

autonumber edit AN02 sequence "{X a9.I}" nextvalue "[E z7.x]" ;

autonumber edit AN01 nextvalue "[f ZA two hundred and ninety eight]" ;

autonumber show AN02 token xml;

autonumber increase AN03 value 20;

autonumber select * get { program class.name objectspace.{ name description } } token xml;


common syntax

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

basic elements
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:
   mypa*er?_ide?ti*

© 2008-2015 MS Enterprise Solutions | Website Templates by IceTemplates.com
Please Read: Privacy Policy and Terms of Use