Generator xy.generator.2.0

This is the meta-generator that is used to define other generators.

Description

A generator specification root element

Attributes

• (required) name

  Identifies the generator. A hierarchical naming pattern is used. Levels in the hierarchy are separated by periods (.). Each word between the '.' characters are mapped to folders and sub-folders in the repository just like in the Java package naming strategy

• (optional) documentation

  The generator documentation

Elements

• 0..1 Input
• 0..1 Output
• 0..1 LocalFunctions

Description

Contains the generator input specification

Elements

• 0..1 Types
• 0..1 RootElements

Description

Contains the generator type definitions

Elements

• 0..n ComplexType

Description

Defines a complex type element

Attributes

• (required) name

  The complex type identifier

• (optional) customLabel.template

  The template used to format the label of every element of this type. If not provided then the default format is applied

• (optional) labelForegroundColor.template

  The template used to set the label foreground color of every element of this type

• (optional) iconOverlayURI.template

  The template used to dynamically locate the icon overlay file from its URI. The file must be a 16x16 GIF image

• (optional) documentation

  The type documentation

Elements

• 0..n Attribute
• 0..n Element
• 0..n Assertion

Description

Defines an attribute

Attributes

• (required) name

  The attribute identifier

• (required) use

  Specifies how the attribute is used

• (optional) enumeration.expression

  XPath expression that returns the possible values of the attribute as a sequence

• (optional) defaultValue

  The default value of the attribute

• (optional) customEditor

  Indicates the custom editor to use to edit this attribute value

• (optional) documentation

  The documentation of the attribute

Description

Declares a composition with elements of a given type

Attributes

• (required) type

  The element type

• (optional) minOccurs

  Specifies the minimum number of times this element can occur in the parent element

• (optional) maxOccurs

  Specifies the maximum number of times this element can occur in the parent element

Description

Defines an assertion constraint

Attributes

• (required) predicate.expression

  The XPath predicate

• (optional) errorMessage.template

  The template used to create the error message that will be shown when the predicate evaluates to 'false'

Description

Defines the root elements allowed in the generator input

Elements

• 0..n Element

Description

Contains the generator output specification

Elements

• 0..n Context
• 0..n Macro

Description

Contains actions that will be executed in the context of a given type

Attributes

• (required) inputType

  The context type name

Elements

• 0..n CreateElement
• 0..n Import
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Element creation action

Attributes

• (required) type

  Name of the type to instanciate

• (optional) attributeSettings

  Specifies the templates used to evaluate the value of the created element attributes.
  The Java property file format is used.

• (optional) exportAs

  This attribute value is used to filter elements that will be imported from another context during the transformation process.
  The 'Import > filter' attribute value is matched against it

Elements

• 0..n CreateElement
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n Import
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Loops through each element in a specified sequence

Attributes

• (required) sequence.expression

  The XPath expression that specifies which sequence to be processed

• (required) itemVar

  The item variable

Elements

• 0..n CreateElement
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n Import
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Allows to guard instructions with a conditional expression

Attributes

• (required) condition.expression

  Specifies the XPath condition to be tested

Elements

• 0..n CreateElement
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n Import
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Executes contained actions if the preceding 'If' conditional expression evaluates to 'false'

Elements

• 0..n CreateElement
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n Import
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Executes a XSLT script that creates the XML representation of elements

Attributes

• (required) stylesheetText

  The XSLT code. It must output valid XML text similar to the one produced by the 'Import/Export XML' feature (http://www.generatexy.org/index.php?option=com_content&view=article&id=80:exportimport-xml&catid=78&Itemid=473).
  Find more information about the XSLT processor here: http://www.saxonica.com/documentation/xsl-elements/intro.xml
  
  Example: generate a simple file indicating the current input type:
  
  <!-- the stylesheet root declaration with useful namespaces declared -->
  <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xy="http://www.generatexy.com" xmlns:local="http://www.generatexy.com/local-function">
  
  	<!-- Every variable accessible from the current context must be decalred as a param -->
  	<xsl:param name="self"/>
  	
  	<!-- template declaration -->
  	<xsl:template match="*">
  		
  		<!-- every root XML element must have the same name as the target generator -->
  		<xsl:element name="xy.any">
  			<!-- create a xy.any:File element -->
  			<xsl:element name="File">
  				<!-- setting the File path attribute value -->
  				<xsl:attribute name="path">sample-xslt.txt</xsl:attribute>
  				<xsl:element name="Text">
  					<xsl:attribute name="value">the current input type is <xsl:value-of select="local-name($self)"/></xsl:attribute>
  				</xsl:element>
  
  				<!-- this is how the 'CreateElement#exportAs' attribute can be set -->
  				<xsl:attribute name="exportAs" namespace="http://www.generatexy.com">exportedIdExample1</xsl:attribute>
  				
  				<!-- this is how elements generated from another context can be imported -->
  				<xy:Import filter="exportedIdExample2" from.expression="xpath/expression/example"/>
  				
  			</xsl:element>
  		</xsl:element>
  
  	</xsl:template>
  </xsl:stylesheet>

Description

Executes Java code that creates elements

Attributes

• (required) statements

  The Java statements that creates the elements.
  You have access to the following variables in the statements:
  - java.util.List<Model> result: The variable that holds the execution result. 
  You have to add your created Models to it.
  Ex: result.add(myModel);
  - xy.Processor.ProcessingContext context: This variable holds information about the processing context.
  Ex: 
  	. context.getNode(): the current element 
  	. context.getModel(): the model of the current node
  	. context.getEngine(): the current engine
  	. ...
  The syntax is similar to a java method body syntax (same variable declarations and assignments, method calls, loops, and conditionals).
  Visit this web page for more information: http://www.beanshell.org/manual/syntax.html#Standard_Java_Syntax
  

Description

Imports actions from another context

Attributes

• (required) from.expression

  XPath expression that specifies the input element that generates the output elements that will be impoted

• (optional) filter

  A regular expression used to select/filter elements that must be imported.
  It is matched against the '(CreateElement|Import)/@exportAs' attribute value.
  Remarks:
  - The Java regular expression syntax is used
  - An empty value would match with empty 'exportAs' attribute value
  - Unless the metacharacters ^ and $ are used as anchors, the string is considered to match the pattern if any substring matches the pattern
  

• (optional) exportAs

  See 'CreateElement > exportAs'. 
  This attribute value is used to set the 'exportAs' attribute value of elements resolved from the current 'Import' specification

Description

Allows to group instructions

Attributes

• (optional) description

  A descriptive text of the group

Elements

• 0..n CreateElement
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n Import
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

A descriptive text

Attributes

• (required) text

  The text value of the comment

Description

Contains parameterized actions that can be executed as a unique instruction elsewhere

Attributes

• (required) name

  The macro identifier

• (optional) parameters

  A comma-separated list of the macro parameters. They are referenced in the macro definition as variables

• (optional) documentation

  The documentation of the macro

Elements

• 0..n CreateElement
• 0..n Import
• 0..n If
• 0..n Else
• 0..n ForEach
• 0..n RunXSLT
• 0..n RunJava
• 0..n ExecuteMacro
• 0..n ActionGroup
• 0..n Comment

Description

Executes a macro

Attributes

• (required) macroName

  The identifier of the macro to execute

• (optional) parameterSettings

  A property string defining the values of the referenced macro parameters.
  The Java property file format is used.

Description

Contains the user-defined functions that can be called from any XPath expression within the generator

Elements

• 0..n Function

Description

Defines a function

Attributes

• (required) name

  The name of the function

• (optional) arguments

  A comma-separated list of the function arguments. They are referenced as variables

• (required) returnValue.expression

  The XPath expression that evaluates the function result

• (optional) documentation

  The documentation of the function