OFBiz - svn commit: r421510 - in /incubator/ofbiz/site: docs/minilang.html training/AdvancedFramework.html

svn commit: r421510 - in /incubator/ofbiz/site: docs/minilang.html training/AdvancedFramework.html

Posted by jonesde on
URL: http://ofbiz.116.s1.nabble.com/svn-commit-r421510-in-incubator-ofbiz-site-docs-minilang-html-training-AdvancedFramework-html-tp208448.html

Author: jonesde
Date: Wed Jul 12 23:10:51 2006
New Revision: 421510

URL: http://svn.apache.org/viewvc?rev=421510&view=rev
Log:
A few small updates to the minilang guide and the adv frmk outline

Modified:
incubator/ofbiz/site/docs/minilang.html
incubator/ofbiz/site/training/AdvancedFramework.html

Modified: incubator/ofbiz/site/docs/minilang.html
URL: http://svn.apache.org/viewvc/incubator/ofbiz/site/docs/minilang.html?rev=421510&r1=421509&r2=421510&view=diff
==============================================================================
--- incubator/ofbiz/site/docs/minilang.html (original)
+++ incubator/ofbiz/site/docs/minilang.html Wed Jul 12 23:10:51 2006
@@ -148,106 +148,11 @@
<hr class="sepbar">
<h3><a name="MapOverview">Simple Map Processor Overview</a></h3>
The Simple Map Processor Mini-Language performes
-two primary tasks: validation
-and conversion. It does this in a context of moving values from one Map
-to another. The
-input map will commonly contain Strings, but can contain other object
-types like Integer, Long,
-Float, Double, java.sql.Date, Time, and Timestamp.
-<hr class="sepbar">
-<h3><a name="MakeInString">Make In String Operations</a></h3>
-make-in-string
-In addition to dealing with the fields already
-in the incoming Map you can build Strings and add them to the in-Map
-before the processing begins with the make-in-string tag. You can have
-zero or
-many make-in-string tags, and they must all come before the process
-tags. Inside each
-make-in-string is a list of snippets to concatenate together to make
-the final String. Each snippet can be another field in the in-Map
-(in-field element), a value from a properties file (property element),
-or a constant (constant element).
-<hr class="sepbar">
-<h3><a name="Process">Process Field Operations</a></h3>
-process
-The process tag is used to contain the
-operations to be done on the specified field in the in-Map. It has one
-required attribute, the field to operate on. The
-operations that it contains are: validate-method, compare,
-compare-field, regexp, not-empty, copy, and convert.
-All process operations tags except copy must
-contain one of two tags: fail-message or fail-property. If the
-operation fails a message is added to
-the message list that is either the specified fail-message, or the
-String from
-the properties file value that is specified in fail-property.
-Messages are collected in List as the Simple Map
-Processor runs. If the List
-is not empty when it completes then something failed in the map
-processor. This
-is done so that all failures will be reported immediately rather than
-having to fix one failure before another can be discovered.
-All process operations automatically convert the
-field value and other values
-from their current type to the type specified for the operation, where
-applicable.
-The ObjectType.simpleTypeConvert method is used to do the conversion.
-It supports
-the following types: String, Double, Float, Long, Integer, Date, Time,
-and Timestamp. If the type is not specified String is the default.
-process:validate-method
-The validate-method tag is used to call any
-static method that accepts
-a String and returns a boolean. If the field coming in is not a String
-it will be converted to a String before calling the method. The two
-attributes
-for this tag are class and method which should contain the fully
-qualified class name and the method name, respectively. If the class
-name is not specified it will default to
-org.ofbiz.base.util.UtilValidate.
-process:compare
-The compare tag is used to compare the field
-value to the value specified
-in the value attribute. An operator must be specified to indicate
-the comparison desired. Operators available include less, greater,
-less-equals, greater-equals, equals, not-equals, and contains.
-process:compare-field
-The compare-field tag is just like the compare
-tag except that instead
-of specifying a value you specify the name of another field in the
-in-Map to compare the current field to.
-process:regexp
-The regexp tag validate the current field
-against the regular expression specified in the expr attribute of the
-tag. Standard Perl style regular
-expressions are used with the ORO library from Jakarta.
-process:not-empty
-The not-empty tag verifies that the current
-field is not empty. If the
-field is a String it must not be null and must have a length greater
-than
-zero, otherwise it must simply not be null. The not-empty tag has no
-attributes.
-process:copy
-The copy operation simply copies the current
-field value to the out-Map from
-the in-Map. There are three optional attributes. If a different field
-name is
-desired in the out-Map it can be specified in the to-field attribute.
-The replace
-attribute can be used to specify if an existing field in the out-Map
-should be replaced or not. The replace attribute defaults to true. The
-set-if-null attribute specifies whether or not the value should be put
-in the out-Map if
-it is null. The default for set-if-null is false.
-process:convert
-The convert tag does the same thing as copy
-except that the type can be
-converted to the type specified in the type attribute. The format
-attribute
-can be used to specify the format for date/time fields. These two tags
-are
-in addition to all of the the attributes in the copy tag.
+two primary tasks: validation and conversion. It does this in a context of moving values from one Map
+to another. The input map will commonly contain Strings, but can contain other object
+types like Integer, Long, Float, Double, java.sql.Date, Time, and Timestamp.
+ NOTE: The reference information for the simple-map-processor has been moved to annotations in the simple-methods.xsd file.
+
<hr class="sepbar">
<h3><a name="MapExample">Simple Map Processors Example</a></h3>
<pre><!DOCTYPE simple-map-processors PUBLIC "-//OFBiz//DTD Simple Methods//EN" "http://www.ofbiz.org/dtds/simple-methods.dtd"> <simple-map-processors> <simple-map-processor name="update"> <make-in-string field="estimatedStartDate"> <in-field field="estimatedStartYear"><constant>-</constant> <in-field field="estimatedStartMonth"><constant>-</constant> <in-field field="estimatedStartDay"><constant>T</constant> <in-field field="estimatedStartHour"><constant>:</constant> <in-field field="estimatedStartMinute"><constant>:</constant> <in-field field="estimatedStartSecond"> </make-in-string> <process field="workEffortId"><copy replace="false"/></process> <process field="scopeEnumId"><copy/></process> <process field="currentStatusId"><copy/><not-empty>
<fail-message message="Status is missing."/></not-empty></process> <process field="priority"><convert type="Long"><fail-message message="Priority is not a valid whole number."/></convert></process> <process field="estimatedStartDate"> <compare-field operator="less" field="estimatedCompletionDate" type="Timestamp" format="yyyy-MM-dd'T'HH:mm:ss"> <fail-message message="Estimated Start date/time must be BEFORE End date/time."/></compare-field> <convert type="Timestamp" format="yyyy-MM-dd'T'HH:mm:ss"> <fail-message message="Estimated Start Date is not a valid Date-Time."/></convert></process> <process field="estimatedCompletionDate"> <convert type="Timestamp"><fail-message message="Estimated Completion Date is not a valid Date-Time."/></convert></process> <process field="estimatedMilliSeconds"> <convert typ
e="Double"><fail-message message="Estimated Milli-seconds is not a valid number."/></convert></process> </simple-map-processor> <simple-map-processor name="delete"> <process field="workEffortId"><copy/><not-empty><fail-message message="Work Effort ID is missing."/></not-empty></process> </simple-map-processor> </simple-map-processors> </pre>

Modified: incubator/ofbiz/site/training/AdvancedFramework.html
URL: http://svn.apache.org/viewvc/incubator/ofbiz/site/training/AdvancedFramework.html?rev=421510&r1=421509&r2=421510&view=diff
==============================================================================
--- incubator/ofbiz/site/training/AdvancedFramework.html (original)
+++ incubator/ofbiz/site/training/AdvancedFramework.html Wed Jul 12 23:10:51 2006
@@ -33,7 +33,7 @@
<div>Email: <a href="mailto:[hidden email]">[hidden email]</a></div>
<div>Open For Business Site: <a href="http://www.ofbiz.org/">http://www.ofbiz.org</a></div>
 
- <div>Last Updated: June 2006</div>
+ <div>Last Updated: July 2006</div>
<hr/>
 
<h3>Target Audience</h3>
@@ -234,7 +234,7 @@
<li>Content, Template, and Page Actions</li>
</ol>
</li>
- <li>Just as in Screen Widget use BeanShell for data preparation and FreeMarker for temapltes</li>
+ <li>Just as in Screen Widget use BeanShell for data preparation and FreeMarker for templates</li>
</ol>
</li>
<li>Region Based Views - Servlet/JSP Templates
@@ -332,6 +332,12 @@
<li>entitydef/entitygroups*.xml</li>
</ol>
</li>
+ <li>Data Type Dictionary
+ <ol>
+ <li>ofbiz/framework/entity/dtd/fieldtypemodel.xsd</li>
+ <li>ofbiz/framework/entity/fieldtype/fieldtype*.xml</li>
+ </ol>
+ </li>
<li>Entity Definitions
<ol>
<li>ofbiz/framework/entity/dtd/entitymodel.xsd</li>
@@ -390,6 +396,12 @@
<li>GenericValue</li>
</ol>
</li>
+ <li>Sequenced Keys
+ <ol>
+ <li>delegator.getNextSeqId</li>
+ <li>SequenceValueItem entity (SEQUENCE_VALUE_ITEM table) - update to avoid key collisions!</li>
+ </ol>
+ </li>
<li>Overview of GenericHelper Interface</li>
<li>Entity ECA (Event-Condition-Action) Rules
<ol>
@@ -398,6 +410,14 @@
<li>When to Use an Entity ECA: Data Maintenance, not Business Processes</li>
<li>Defining Entity ECAs</li>
<li>Limitations</li>
+ </ol>
+ </li>
+ <li>Entity XML Import/Export
+ <ol>
+ <li>XML File Format: Basic</li>
+ <li>XML File Format: Pre-Transformed</li>
+ <li>Command Line Import</li>
+ <li>WebTools WebApp Import and Export Pages</li>
</ol>
</li>
</ol>