JSFUtils (AndroMDA JSF2 Cartridge 3.5-SNAPSHOT API)

java.lang.Object
- org.andromda.cartridges.jsf2.JSFUtils

```
public class JSFUtils
extends Object
```
Utilities for use within the JSF cartridge.

Author:

Chad Brandon

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`VT_CREDIT_CARD` "creditCard"
`static String`	`VT_DOUBLE_RANGE` "doubleRange"
`static String`	`VT_EMAIL` "email"
`static String`	`VT_EQUAL` "equal"
`static String`	`VT_FLOAT_RANGE` "floatRange"
`static String`	`VT_INT_RANGE` "intRange"
`static String`	`VT_MASK` "mask"
`static String`	`VT_MAX_LENGTH` "maxlength"
`static String`	`VT_MIN_LENGTH` "minlength"
`static String`	`VT_REQUIRED` "required"
`static String`	`VT_URL` "url"
`static String`	`VT_VALID_WHEN` "validwhen"

Constructor Summary

Constructors
Constructor and Description

JSFUtils()

Constructors
Constructor and Description
`JSFUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`calcSerialVersionUID(StringBuilder buffer)`
`int`	`calculateIcefacesTimeout(String string)`
`static String`	`constructDummyArrayDeclaration(String name, int count)` Constructs a string representing an array initialization in Java.
`static String`	`getDate()` Returns the current Date
`static String`	`getDate(String format)` Returns the current Date in the specified format.
`static String`	`getDateFormat(String format)`
`static String`	`getEqual(ModelElementFacade element)` Retrieves the "equal" value from the given element (if one is present).
`static String`	`getEqual(ModelElementFacade element, ParameterFacade ownerParameter)` Retrieves the "equal" value from the given element (if one is present).
`static String`	`getFormat(ModelElementFacade element, ClassifierFacade type, String defaultDateFormat, String defaultTimeFormat)` Gets the format string for the given `element`.
`static String`	`getInputFormat(ModelElementFacade element)` Retrieves the input format (if one is defined), for the given `element`.
`static String`	`getMaxLengthValue(String format)`
`static String`	`getMinLengthValue(String format)`
`static String`	`getPatternValue(String format)`
`static String`	`getRangeEnd(String format)`
`static String`	`getRangeStart(String format)`
`String`	`getRequestClassName()`
`String`	`getResponseClassName()`
`String`	`getSessionClassName()`
`static String`	`getToken(String string, int index, int limit)`
`static Collection`	`getValidatorArgs(ModelElementFacade element, String validatorType)` Gets the validator args for the `element` and the given `validatorType`.
`static Collection<String>`	`getValidatorTypes(ModelElementFacade element, ClassifierFacade type)` Retrieves the validator types as a collection from the given `element` (if any can be retrieved).
`static Collection<List<String>>`	`getValidatorVars(ModelElementFacade element, ClassifierFacade type, ParameterFacade ownerParameter)` Gets the validator variables for the given `element` (if they can be retrieved).
`static String`	`getValidWhen(ModelElementFacade element)` Retrieves the "validwhen" value from the given element (if one is present).
`String`	`getViewExtension()` Gets the extension for the view type.
`static boolean`	`isByte(ClassifierFacade type)`
`static boolean`	`isCreditCardFormat(String format)` Indicates if the given `format` is a credit card format.
`static boolean`	`isDate(ClassifierFacade type)`
`static boolean`	`isDouble(ClassifierFacade type)`
`static boolean`	`isEmailFormat(String format)` Indicates if the given `format` is an email format.
`static boolean`	`isEqualFormat(String format)` Indicates if the given `format` is an equal format.
`static boolean`	`isFloat(ClassifierFacade type)`
`static boolean`	`isInteger(ClassifierFacade type)`
`static boolean`	`isLong(ClassifierFacade type)`
`static boolean`	`isMaxLengthFormat(String format)` Indicates if the given `format` is a maxlength format.
`static boolean`	`isMinLengthFormat(String format)` Indicates if the given `format` is a minlength format.
`static boolean`	`isPatternFormat(String format)` Indicates if the given `format` is a pattern format.
`static boolean`	`isRangeFormat(String format)` Indicates if the given `format` is a range format.
`static boolean`	`isReadOnly(ModelElementFacade element)` Indicates if the given element is read-only or not.
`static boolean`	`isShort(ClassifierFacade type)`
`static boolean`	`isStrictDateFormat(ModelElementFacade element)` Indicates whether or not the format for this element is a strict date format.
`static boolean`	`isStrictDateFormat(String format)`
`static boolean`	`isString(ClassifierFacade type)`
`static boolean`	`isTime(ClassifierFacade type)`
`static boolean`	`isUrl(ClassifierFacade type)`
`static List<String>`	`parseValidatorArgs(String validatorTaggedValue)` Reads the validator arguments from the the given tagged value.
`static String`	`parseValidatorName(String validatorTaggedValue)` Parses the validator name for a tagged value.
`static List<String>`	`parseValidatorVars(String validatorTaggedValue)` Reads the validator variable names from the the given tagged value.
`void`	`setStrictDateTimeFormat(boolean strictDateTimeFormat)` Sets whether or not the date patterns should be treated as strict.
`static String`	`toWebResourceName(String string)` Converts the argument into a web resource name, this means: all lowercase characters and words are separated with dashes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VT_REQUIRED
```
public static final String VT_REQUIRED
```
    "required"
    
    See Also:
    Constant Field Values
  - VT_URL
```
public static final String VT_URL
```
    "url"
    
    See Also:
    Constant Field Values
  - VT_INT_RANGE
```
public static final String VT_INT_RANGE
```
    "intRange"
    
    See Also:
    Constant Field Values
  - VT_FLOAT_RANGE
```
public static final String VT_FLOAT_RANGE
```
    "floatRange"
    
    See Also:
    Constant Field Values
  - VT_DOUBLE_RANGE
```
public static final String VT_DOUBLE_RANGE
```
    "doubleRange"
    
    See Also:
    Constant Field Values
  - VT_EMAIL
```
public static final String VT_EMAIL
```
    "email"
    
    See Also:
    Constant Field Values
  - VT_CREDIT_CARD
```
public static final String VT_CREDIT_CARD
```
    "creditCard"
    
    See Also:
    Constant Field Values
  - VT_MIN_LENGTH
```
public static final String VT_MIN_LENGTH
```
    "minlength"
    
    See Also:
    Constant Field Values
  - VT_MAX_LENGTH
```
public static final String VT_MAX_LENGTH
```
    "maxlength"
    
    See Also:
    Constant Field Values
  - VT_MASK
```
public static final String VT_MASK
```
    "mask"
    
    See Also:
    Constant Field Values
  - VT_VALID_WHEN
```
public static final String VT_VALID_WHEN
```
    "validwhen"
    
    See Also:
    Constant Field Values
  - VT_EQUAL
```
public static final String VT_EQUAL
```
    "equal"
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JSFUtils
```
public JSFUtils()
```
- Method Detail
  - toWebResourceName
```
public static String toWebResourceName(String string)
```
    Converts the argument into a web resource name, this means: all lowercase characters and words are separated with dashes.
    
    Parameters:
    string - any string
    
    Returns:
    the string converted to a value that would be well-suited for a web file name
  - parseValidatorArgs
```
public static List<String> parseValidatorArgs(String validatorTaggedValue)
```
    Reads the validator arguments from the the given tagged value.
    
    Parameters:
    validatorTaggedValue -
    
    Returns:
    returns a list of String instances or an empty list
    
    Throws:
    
    IllegalArgumentException - when the input string does not match the required pattern
  - parseValidatorVars
```
public static List<String> parseValidatorVars(String validatorTaggedValue)
```
    Reads the validator variable names from the the given tagged value.
    
    Parameters:
    validatorTaggedValue -
    
    Returns:
    never null, returns a list of String instances
    
    Throws:
    
    IllegalArgumentException - when the input string does not match the required pattern
  - parseValidatorName
```
public static String parseValidatorName(String validatorTaggedValue)
```
    Parses the validator name for a tagged value.
    
    Parameters:
    validatorTaggedValue -
    
    Returns:
    validatorTaggedValue
    
    Throws:
    
    IllegalArgumentException - when the input string does not match the required pattern
  - constructDummyArrayDeclaration
```
public static String constructDummyArrayDeclaration(String name,
                                    int count)
```
    Constructs a string representing an array initialization in Java.
    
    Parameters:
    name - the name to give the array.
    count - the number of items to give the array.
    
    Returns:
    A String representing Java code for the initialization of an array.
  - getDateFormat
```
public static String getDateFormat(String format)
```
    Parameters:
    format -
    
    Returns:
    this field's date format
  - getDate
```
public static String getDate(String format)
```
    Returns the current Date in the specified format.
    
    Parameters:
    format - The format for the output date
    
    Returns:
    the current date in the specified format.
  - getDate
```
public static String getDate()
```
    Returns the current Date
    
    Returns:
    the current date in the default format.
  - isStrictDateFormat
```
public static boolean isStrictDateFormat(String format)
```
    Parameters:
    format -
    
    Returns:
    true if this field's value needs to conform to a strict date format, false otherwise
  - isEmailFormat
```
public static boolean isEmailFormat(String format)
```
    Indicates if the given format is an email format.
    
    Parameters:
    format -
    
    Returns:
    true if this field is to be formatted as an email address, false otherwise
  - isEqualFormat
```
public static boolean isEqualFormat(String format)
```
    Indicates if the given format is an equal format.
    
    Parameters:
    format -
    
    Returns:
    true if this field is to be formatted as an email address, false otherwise
  - isCreditCardFormat
```
public static boolean isCreditCardFormat(String format)
```
    Indicates if the given format is a credit card format.
    
    Parameters:
    format -
    
    Returns:
    true if this field is to be formatted as a credit card, false otherwise
  - isPatternFormat
```
public static boolean isPatternFormat(String format)
```
    Indicates if the given format is a pattern format.
    
    Parameters:
    format -
    
    Returns:
    true if this field's value needs to respect a certain pattern, false otherwise
  - isMinLengthFormat
```
public static boolean isMinLengthFormat(String format)
```
    Indicates if the given format is a minlength format.
    
    Parameters:
    format -
    
    Returns:
    true if this field's value needs to consist of at least a certain number of characters, false otherwise
  - isMaxLengthFormat
```
public static boolean isMaxLengthFormat(String format)
```
    Indicates if the given format is a maxlength format.
    
    Parameters:
    format -
    
    Returns:
    true if this field's value needs to consist of at maximum a certain number of characters, false otherwise
  - getToken
```
public static String getToken(String string,
              int index,
              int limit)
```
    Parameters:
    string -
    index -
    limit -
    
    Returns:
    the i-th space delimited token read from the argument String, where i does not exceed the specified limit
  - getInputFormat
```
public static String getInputFormat(ModelElementFacade element)
```
    Retrieves the input format (if one is defined), for the given element.
    
    Parameters:
    element - the model element for which to retrieve the input format.
    
    Returns:
    the input format.
  - isRangeFormat
```
public static boolean isRangeFormat(String format)
```
    Indicates if the given format is a range format.
    
    Parameters:
    format -
    
    Returns:
    true if this field's value needs to be in a specific range, false otherwise
  - isByte
```
public static boolean isByte(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a byte, false otherwise
  - isShort
```
public static boolean isShort(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a short, false otherwise
  - isInteger
```
public static boolean isInteger(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is an integer, false otherwise
  - isLong
```
public static boolean isLong(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a long integer, false otherwise
  - isFloat
```
public static boolean isFloat(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a floating point, false otherwise
  - isDouble
```
public static boolean isDouble(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a double precision floating point, false otherwise
  - isDate
```
public static boolean isDate(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a date, false otherwise
  - isTime
```
public static boolean isTime(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a time, false otherwise
  - isUrl
```
public static boolean isUrl(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a URL, false otherwise
  - isString
```
public static boolean isString(ClassifierFacade type)
```
    Parameters:
    type -
    
    Returns:
    true if the type of this field is a String, false otherwise
  - isReadOnly
```
public static boolean isReadOnly(ModelElementFacade element)
```
    Indicates if the given element is read-only or not.
    
    Parameters:
    element - the element to check.
    
    Returns:
    true/false
  - getEqual
```
public static String getEqual(ModelElementFacade element)
```
    Retrieves the "equal" value from the given element (if one is present).
    
    Parameters:
    element - the element from which to retrieve the equal value.
    
    Returns:
    the "equal" value.
  - getEqual
```
public static String getEqual(ModelElementFacade element,
              ParameterFacade ownerParameter)
```
    Retrieves the "equal" value from the given element (if one is present).
    
    Parameters:
    element - the element from which to retrieve the equal value.
    ownerParameter - the optional owner parameter (specified if the element is an attribute).
    
    Returns:
    the "equal" value.
  - getValidWhen
```
public static String getValidWhen(ModelElementFacade element)
```
    Retrieves the "validwhen" value from the given element (if one is present).
    
    Parameters:
    element - the element from which to retrieve the validwhen value.
    
    Returns:
    the "validwhen" value.
  - getRangeStart
```
public static String getRangeStart(String format)
```
    Parameters:
    format -
    
    Returns:
    the lower limit for this field's value's range
  - getRangeEnd
```
public static String getRangeEnd(String format)
```
    Parameters:
    format -
    
    Returns:
    the upper limit for this field's value's range
  - getMinLengthValue
```
public static String getMinLengthValue(String format)
```
    Parameters:
    format -
    
    Returns:
    the minimum number of characters this field's value must consist of
  - getMaxLengthValue
```
public static String getMaxLengthValue(String format)
```
    Parameters:
    format -
    
    Returns:
    the maximum number of characters this field's value must consist of
  - getPatternValue
```
public static String getPatternValue(String format)
```
    Parameters:
    format -
    
    Returns:
    the pattern this field's value must respect
  - getValidatorTypes
```
public static Collection<String> getValidatorTypes(ModelElementFacade element,
                                   ClassifierFacade type)
```
    Retrieves the validator types as a collection from the given element (if any can be retrieved).
    
    Parameters:
    element - the element from which to retrieve the types.
    type - the type of the element.
    
    Returns:
    the collection of validator types.
  - getValidatorVars
```
public static Collection<List<String>> getValidatorVars(ModelElementFacade element,
                                        ClassifierFacade type,
                                        ParameterFacade ownerParameter)
```
    Gets the validator variables for the given element (if they can be retrieved).
    
    Parameters:
    element - the element from which to retrieve the variables
    type - the type of the element.
    ownerParameter - the optional owner parameter (if the element is an attribute for example).
    
    Returns:
    the collection of validator variables.
  - getValidatorArgs
```
public static Collection getValidatorArgs(ModelElementFacade element,
                          String validatorType)
```
    Gets the validator args for the element and the given validatorType.
    
    Parameters:
    element - the element for which to retrieve the arguments.
    validatorType - the validator type name.
    
    Returns:
    the validator args as a collection.
  - setStrictDateTimeFormat
```
public void setStrictDateTimeFormat(boolean strictDateTimeFormat)
```
    Sets whether or not the date patterns should be treated as strict.
    
    Parameters:
    strictDateTimeFormat -
  - isStrictDateFormat
```
public static boolean isStrictDateFormat(ModelElementFacade element)
```
    Indicates whether or not the format for this element is a strict date format.
    
    Parameters:
    element -
    
    Returns:
    true/false
  - getFormat
```
public static String getFormat(ModelElementFacade element,
               ClassifierFacade type,
               String defaultDateFormat,
               String defaultTimeFormat)
```
    Gets the format string for the given element.
    
    Parameters:
    element - the element for which to retrieve the format.
    type - the type of the element.
    defaultDateFormat -
    defaultTimeFormat -
    
    Returns:
    the format string (if one is present otherwise null).
  - getViewExtension
```
public String getViewExtension()
```
    Gets the extension for the view type.
    
    Returns:
    the view type extension.
  - getRequestClassName
```
public String getRequestClassName()
```
    Returns:
    className
  - getResponseClassName
```
public String getResponseClassName()
```
    Returns:
    className
  - getSessionClassName
```
public String getSessionClassName()
```
    Returns:
    className
  - calcSerialVersionUID
```
public static String calcSerialVersionUID(StringBuilder buffer)
```
    Parameters:
    buffer -
    
    Returns:
    the calculated SerialVersionUID
  - calculateIcefacesTimeout
```
public int calculateIcefacesTimeout(String string)
```
    Parameters:
    string -
    
    Returns:
    Integer.valueOf(string) * 6000

Class JSFUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VT_REQUIRED

VT_URL

VT_INT_RANGE

VT_FLOAT_RANGE

VT_DOUBLE_RANGE

VT_EMAIL

VT_CREDIT_CARD

VT_MIN_LENGTH

VT_MAX_LENGTH

VT_MASK

VT_VALID_WHEN

VT_EQUAL

Constructor Detail

JSFUtils

Method Detail

toWebResourceName

parseValidatorArgs

parseValidatorVars

parseValidatorName

constructDummyArrayDeclaration

getDateFormat

getDate

getDate

isStrictDateFormat

isEmailFormat

isEqualFormat

isCreditCardFormat

isPatternFormat

isMinLengthFormat

isMaxLengthFormat

getToken

getInputFormat

isRangeFormat

isByte

isShort

isInteger

isLong

isFloat

isDouble

isDate

isTime

isUrl

isString

isReadOnly

getEqual

getEqual

getValidWhen

getRangeStart

getRangeEnd

getMinLengthValue

getMaxLengthValue

getPatternValue

getValidatorTypes

getValidatorVars

getValidatorArgs

setStrictDateTimeFormat

isStrictDateFormat

getFormat

getViewExtension

getRequestClassName

getResponseClassName

getSessionClassName

calcSerialVersionUID

calculateIcefacesTimeout