OBERON - OOQL Language

menu

project

documentation

support

applications

downloads

contacts

filetype

file format for object attachments

define - create new filetype definition

  filetype define AdminName {FileType_DefineOption} ;

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

  filetype clone AdminName define AdminName {FileType_EditOption} ;

edit - update the filetype properties

  filetype edit AdminName {FileType_EditOption};

show - print the filetype properties

  filetype show AdminName [FileType_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract filetypes on the base of query filters

  filetype select AdminPatternList {Filter_Option} [FileType_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

undefine - remove a filetype from the database [all related files will be deleted]

  filetype undefine AdminName ;

FileType_DefineOption
	description GenericValue
	application AdminName
	image FileName
	imagedata GenericString
	extension GenericValue
	mimetype GenericValue
	[! /not] hidden

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

FileType_GetOption
	get [FileType_GetBasicOption]

	FileType_GetBasicOption
		{ FileType_GetBasicToken [as IDENTIFIER] { FileType_GetBasicToken [as IDENTIFIER] } }
		FileType_GetBasicToken [as IDENTIFIER]

		FileType_GetBasicToken
			Common_GetBasicOption
			extension
			mimetype
			lifecycle	[. Lifecycle_GetBasicOption]
			lifecycle[]	[. Lifecycle_GetBasicOption]
			lifecycle[ AdminName ]

KEYWORDs
	application	the associated application menu
	description	the filetype description
	extension	the file extension for uploaded files
	hidden	administration hidden objects are not visible/usable
	lifecycle	list of lifecycles which support this filetype for the object attachments
	image	local path for the filetype icon to upload
	imagedata	base64 code for the filetype icon
	mimetype	the file MIME type [format] for uploaded files
	moddate	last modification date
	name	the filetype name
	svnrev	SVN repository revision number

SAMPLES

filetype define FT01 description "MYft" image "C:\Images\gificon.gif" extension ".gif" mimetype "/gif/mime" !hidden;

filetype clone FT01 define "FT02" extension ".jpg" ;

filetype edit FT01 name FT03 !hidden;

filetype show FT01 get { name mimetype extension moddate } token { "|" };

filetype show FT02;

filetype show 'FT02' get { name mimetype feature[MYFEAT1].value } token { "|" "," ";" } ;

filetype select * get { name description extension mimetype } token "|" ;

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
	xml

ExportFile_Option
	exportfile FileName [append] [xml]

ImportFile_Option
	importfile FileName [xml / 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 o more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
	example: Var1 object_Name_02

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