utility-macros 1.2

Summary

JPlate utility macros

Import Summary

Import Definitions
File	Description	Comment
${jplate.LOCALE_HOME}/jplate-build-properties-messages.xml	Import local specific messages.	Import locale specific messages.
common.xml	Contains all JPlate common work.	Import our common work...

Macro Definition Summary

Macro Definitions
Name	Description	URI
assert-equal	Determines if `@{str1}` is equal to `@{str2}`. If the two are not equal, message defined in `@{error-msg}` is displayed.	http://jplate.sourceforge.net/utility
assert-is-number	Determines if `@{number}` is a number. If `@{number}` is not a number, `@{error-msg}` will be displayed.	http://jplate.sourceforge.net/utility
assert-not-equal	Determines if `@{str1}` is not equal to `@{str2}`. If the two are equal, message defined in `@{error-msg}` is displayed.	http://jplate.sourceforge.net/utility
assert-ref-id	Determines if `@{ref-id}` is a ref id and if not fails with an error message defined in `@{error-msg}`.	http://jplate.sourceforge.net/utility
compute-branch	Compute the branch based upon a root dir, `@{root}`, and full path, `@{full-path}`. The branch represents the full path minus the root dir. Please note: if `@{root}` does not exist in `@{full-path}`, `@{property}` will be set with an empty value.	http://jplate.sourceforge.net/utility
compute-number-left-trim	Trim preceeding 0's from `@{number}` and store in the property entitled `@{property}`.	http://jplate.sourceforge.net/utility
compute-number-right-trim	Trim ppostceeding 0's from `@{number}` after decimal and store in the property entitled `@{property}`.	http://jplate.sourceforge.net/utility
compute-number-trim	Trim ppostceeding 0's from `@{number}` after decimal and store in the property entitled `@{property}`.	http://jplate.sourceforge.net/utility
compute-replacement	Replace characters from `@{str}`. The characters to be replaced are contained in `@{to-replace}`. The replacement characters are contained in `@{replacement}`. The replaced data is stored in property `@{property}`. Please note if `@{str}` does not contain any data in `@{to-replace}` the value of `@{property}` will be `@{str}`.	http://jplate.sourceforge.net/utility
compute-timestamp	Compute the current time stamp in YYYY-MM-DD_HH-MM-SS.	http://jplate.sourceforge.net/utility
number-compare	Implements a simplistic switch/case for comparing two numbers - less than, greater than, equal to or not equal.	http://jplate.sourceforge.net/utility
process-list	Allows one to iterate over a list/files and for each element in the list know the previous, current and next values.	http://jplate.sourceforge.net/utility

Details

Macro Definition Details

assert-equal

Determines if @{str1} is equal to @{str2}. If the two are not equal, message defined in @{error-msg} is displayed.

Attribute Definitions
Name	Description	Default
str1	Compared to `@{str2}`.	Not Defined
str2	Compared to `@{str1}`.	Not Defined
error-msg	The message to display if `@{str1}` not equal to `@{str2}`.	${jplate-utility.assert-equal.error-msg}
description	Information about this macro call.	Not Defined

@{str1}

@{str2}

@{error-msg}

Attributes
@{str1} = compared to @{str2}.
@{str2} = compared to @{str1}.
@{error-msg} = if @{str1} not equal to @{str2}, the message when failing will be displayed.
@{description} = information about calling this macro.

assert-is-number

Determines if @{number} is a number. If @{number} is not a number, @{error-msg} will be displayed.

Attribute Definitions
Name	Description	Default
number	Used to determine if a number or not.	Not Defined
error-msg	The message to display if `@{number}` is not a number.	${jplate-utility.assert-is-number.error-msg}
description	Information about this macro call.	Not Defined

@{number}

@{error-msg}

Attributes
@{number} = used to determine if a number.
@{error-msg} = if @{number} is not a number, the message to be displayed.
@{description} = information about calling this macro.

assert-not-equal

Determines if @{str1} is not equal to @{str2}. If the two are equal, message defined in @{error-msg} is displayed.

Attribute Definitions
Name	Description	Default
str1	Compared to `@{str2}`.	Not Defined
str2	Compared to `@{str1}`.	Not Defined
error-msg	The message to display if `@{str1}` equals `@{str2}`.	${jplate-utility.assert-not-equal.error-msg}
description	Information about this macro call.	Not Defined

@{str1}

@{str2}

@{error-msg}

Attributes
@{str1} = compared to @{str2}.
@{str2} = compared to @{str1}.
@{error-msg} = if @{str1} equal to @{str2}, the message when failing will be displayed.
@{description} = information about calling this macro.

assert-ref-id

Determines if @{ref-id} is a ref id and if not fails with an error message defined in @{error-msg}.

Attribute Definitions
Name	Description	Default
ref-id	The name of the ref id that should be a ref id.	Not Defined
error-msg	The message to display if `@{ref-id}` is not a ref id.	${jplate-utility.assert-ref-id.error-msg}
description	Information about this macro call.	Not Defined

@{ref-id}

@{error-msg}

Attributes
@{ref-id} = the name of the ref id that "should" be a ref id.
@{error-msg} = if @{property} is not set, the message when failing will be displayed.
@{description} = information about calling this macro.

compute-branch

Compute the branch based upon a root dir, @{root}, and full path, @{full-path}. The branch represents the full path minus the root dir. Please note: if @{root} does not exist in @{full-path}, @{property} will be set with an empty value.

Attribute Definitions
Name	Description	Default
root	The root of the path defined in `@{full-path}`.	Not Defined
full-path	The absolute path for which `@{root}` is the root of the path and the branch computed is this path minus the root.	Not Defined
property	The property to set with the branch.	Not Defined
description	Information about this macro call.	Not Defined

@{root}

@{full-path}

Please note:

@{root}

@{full-path}

@{property}

Attributes
@{root} = the root of the path defined in @{full-path}.
@{full-path} = the absolute path for which @{root} is the root of the path and the branch computed is this path minus the root.
@{property} = the property to set with the branch.
@{description} = information about calling this macro.

Example
@{root} = /foo/bar/alpha
@{full-path} = /foo/bar/alpha/beta/theta/zeta

Result
@{property} = beta/theta/zeta.

Example
@{root} = /hello/world
@{full-path} = /foo/bar/alpha/beta/theta/zeta

Result
@{property} =

compute-number-left-trim

Trim preceeding 0's from @{number} and store in the property entitled @{property}.

Attribute Definitions
Name	Description	Default
property	The name of the property to store the results of triming preceeding 0's from `@{number}`.	Not Defined
number	The number who will have preceeding 0's trimmed.	Not Defined
description	Information about this macro call.	Not Defined

@{number}

Attributes
@{property} = the name of the property to store the results of triming preceeding 0's from @{number}.
@{number} = the number who will have preceeding 0's trimmed.
@{description} = information about calling this macro.

Example
@{number} = 0030006

Result
@{property} = 30006

compute-number-right-trim

Trim ppostceeding 0's from @{number} after decimal and store in the property entitled @{property}.

Attribute Definitions
Name	Description	Default
property	The name of the property to store the results of triming postceeing 0's from decimal point from `@{number}`.	Not Defined
number	The number who will have preceeding 0's trimmed.	Not Defined
description	Information about this macro call.	Not Defined

@{number}

@{property}

Attributes
@{property} = the name of the property to store the results of triming postceeding 0's from @{number}.
@{number} = the number who will have preceeding 0's trimmed.
@{description} = information about calling this macro.

Example
@{number} = 30006.123980192830000

Result
@{property} = 30006.12398019283

compute-number-trim

Trim ppostceeding 0's from @{number} after decimal and store in the property entitled @{property}.

Attribute Definitions
Name	Description	Default
property	The name of the property to store the results of triming postceeing 0's from decimal point from `@{number}`.	Not Defined
number	The number who will have preceeding 0's trimmed.	Not Defined
description	Information about this macro call.	Not Defined

@{number}

@{property}

Example
@{number} = 000030006.123980192830000

Result
@{property} = 30006.12398019283

compute-replacement

Replace characters from @{str}. The characters to be replaced are contained in @{to-replace}. The replacement characters are contained in @{replacement}. The replaced data is stored in property @{property}. Please note if @{str} does not contain any data in @{to-replace} the value of @{property} will be @{str}.

Attribute Definitions
Name	Description	Default
str	The string containing characters to be replaced.	Not Defined
to-replace	The characters to replace in `@{str}`.	Not Defined
replacement	The replacement characters that will replace `@{to-replace}` in `@{str}`.	Not Defined
property	The name of the property to hold the replaced characters.	Not Defined
description	Information about this macro call.	Not Defined

@{str}

@{to-replace}

@{replacement}

@{property}

Please note:

@{str}

@{to-replace}

@{property}

@{str}

Attributes
@{str} = the string containing characters to be replaced.
@{to-replace} = the characters to replace in @{str}.
@{replacement} = replacement characters that will replace @{to-replace} in @{str}.
@{property} = the property to store the class branch information.
@{description} = information about calling this macro.

Example
@{str} = Hello World
@{to-replace} = lo Wo
@{replacement} = YES

Result
@{property} = HelYESrld

compute-timestamp

Compute the current time stamp in YYYY-MM-DD_HH-MM-SS.

Attribute Definitions
Name	Description	Default
property	The property to set with the current time stamp.	Not Defined
prefix	The prefix for property when time stamp is computed and stored in `@{property}`.	Not Defined
suffix	The suffix for property when time stamp is computed and stored in `@{property}`.	Not Defined
description	Information about this macro call.	Not Defined

Attributes
@{property} = the property to set with the current time stamp.
@{prefix} = the prefix for property when time stamp is computed and stored in @{property}.
@{suffix} = the suffix for property when time stamp is computed and stored in @{property}.
@{description} = information about calling this macro.

Example
@{prefix} = foo_
@{suffix} = _bar
current time = February 10, 2005 11:05:30 am

Result
@{property} = foo_2005-02-10_11-05-30_bar

number-compare

Implements a simplistic switch/case for comparing two numbers - less than, greater than, equal to or not equal.

Attribute Definitions
Name	Description	Default
arg1	Compared against `@{arg2}`.	Not Defined
arg2	Compared against `@{arg1}`.	Not Defined
description	Information about this macro call.	Not Defined

Attributes
@{arg1} = compared against @{arg2}.
@{arg2} = compared against @{arg1}.
@{description} = information about calling this macro.

Elements
@{equal} = the block of code to execute if @{arg1} = @{arg2}.
@{not-equal} = the block of code to execute if @{arg1} != @{arg2}.
@{less} = the block of code to execute if @{arg1} < @{arg2}.
@{greater} = the block of code to execute if @{arg1} > @{arg2}.

process-list

Allows one to iterate over a list/files and for each element in the list know the previous, current and next values.

Attribute Definitions
Name	Description	Default
list	The list to process.	Not Defined
delimiter	The delimiter for `@{list}`.	,
previous	Name of property to hold previous value in list.	jplate-utility.PREVIOUS
current	Name of property to hold current value in list.	jplate-utility.CURRENT
next	Name of property to hold next value in list.	jplate-utility.NEXT
description	Information about this macro call.	Not Defined

@{previous}

@{current}

@{next}

Attributes
@{list} = list to process.
@{delimiter} = separator for elements in @{list}.
@{previous} = name of property that will hold the previous element.
@{current} = name of property that will hold the current element.
@{next} = name of property that will hold the next element.
@{description} = information about calling this macro.

Elements
@{path} = should hold a file list to process.
@{process} = called for each iteration of elements in the list. The various elements can be accessed via the properties named in @{previous}, @{current} and @{next}.