Package org.frankframework.parameters

Enum Class ParameterType

java.lang.Object
java.lang.Enum<ParameterType>
org.frankframework.parameters.ParameterType
All Implemented Interfaces:
Serializable, Comparable<ParameterType>, Constable
public enum ParameterType extends Enum<ParameterType>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BINARY
    Forces the parameter value to be treated as binary data (e.g. when using a SQL BLOB field).
    BOOLEAN
    Converts the result to a Boolean
    BYTES
    Deprecated.
    CHARACTER
    Forces the parameter value to be treated as character data (e.g. when using a SQL CLOB field).
    DATE
    Converts the result to a Date, by default using formatString yyyy-MM-dd.
    DATETIME
    Converts the result to a Date, by default using formatString yyyy-MM-dd HH:mm:ss.
    DOMDOC
    Renders XML as a DOM document; similar to node with the distinction that there is always a common root node (required for XSLT 2.0)
    INPUTSTREAM
    Deprecated.
    INTEGER
    Converts the result to an Integer
    LIST
    Used for StoredProcedure OUT parameters when the database type is a CURSOR or JDBCType.REF_CURSOR.
    MAP
    Deprecated.
    NODE
    Deprecated, for removal: This API element is subject to removal in a future version.
    NUMBER
    Converts the result to a Number, using decimalSeparator and groupingSeparator.
    STRING
    Renders the contents of the first node (in combination with xslt or xpath).
    TIME
    Converts the result to a Date, by default using formatString HH:mm:ss.
    TIMESTAMP
    Similar to DATETIME, except for the formatString that is yyyy-MM-dd HH:mm:ss.SSS by default
    XML
    Renders an xml-nodeset as an xml-string (in combination with xslt or xpath).
    XMLDATETIME
    Converts the result from a XML formatted dateTime to a Date.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final boolean
    requiresTypeConversion
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<? extends IParameter>
    getTypeClass()
     
    static ParameterType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ParameterType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • STRING

      public static final ParameterType STRING
      Renders the contents of the first node (in combination with xslt or xpath). Please note that if there are child nodes, only the contents are returned, use XML if the xml tags are required

    • XML

      public static final ParameterType XML
      Renders an xml-nodeset as an xml-string (in combination with xslt or xpath). This will include the xml tags

    • NODE

      @ConfigurationWarning("ParameterType NODE is deprecated, use DOMDOC instead") @Deprecated(since="9.0.0", forRemoval=true) public static final ParameterType NODE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Renders the CONTENTS of the first node as a nodeset that can be used as such when passed as xslt-parameter (only for XSLT 1.0). Please note that the nodeset may contain multiple nodes, without a common root node. N.B. The result is the set of children of what you might expect it to be...

    • DOMDOC

      public static final ParameterType DOMDOC
      Renders XML as a DOM document; similar to node with the distinction that there is always a common root node (required for XSLT 2.0)

    • DATE

      public static final ParameterType DATE
      Converts the result to a Date, by default using formatString yyyy-MM-dd. When applied as a JDBC parameter, the method setDate() is used

    • TIME

      public static final ParameterType TIME
      Converts the result to a Date, by default using formatString HH:mm:ss. When applied as a JDBC parameter, the method setTime() is used

    • DATETIME

      public static final ParameterType DATETIME
      Converts the result to a Date, by default using formatString yyyy-MM-dd HH:mm:ss. When applied as a JDBC parameter, the method setTimestamp() is used

    • TIMESTAMP

      public static final ParameterType TIMESTAMP
      Similar to DATETIME, except for the formatString that is yyyy-MM-dd HH:mm:ss.SSS by default

    • XMLDATETIME

      public static final ParameterType XMLDATETIME
      Converts the result from a XML formatted dateTime to a Date. When applied as a JDBC parameter, the method setTimestamp() is used

    • NUMBER

      public static final ParameterType NUMBER
      Converts the result to a Number, using decimalSeparator and groupingSeparator. When applied as a JDBC parameter, the method setDouble() is used

    • INTEGER

      public static final ParameterType INTEGER
      Converts the result to an Integer

    • BOOLEAN

      public static final ParameterType BOOLEAN
      Converts the result to a Boolean

    • INPUTSTREAM

      @ConfigurationWarning("use type [BINARY] instead") @Deprecated public static final ParameterType INPUTSTREAM
      Deprecated.
      Only applicable as a JDBC parameter, the method setBinaryStream() is used

    • BYTES

      @ConfigurationWarning("use type [BINARY] instead") @Deprecated public static final ParameterType BYTES
      Deprecated.
      Only applicable as a JDBC parameter, the method setBytes() is used

    • BINARY

      public static final ParameterType BINARY
      Forces the parameter value to be treated as binary data (e.g. when using a SQL BLOB field). When applied as a JDBC parameter, the method setBinaryStream() or setBytes() is used

    • CHARACTER

      public static final ParameterType CHARACTER
      Forces the parameter value to be treated as character data (e.g. when using a SQL CLOB field). When applied as a JDBC parameter, the method setCharacterStream() or setString() is used

    • LIST

      public static final ParameterType LIST
      Used for StoredProcedure OUT parameters when the database type is a CURSOR or JDBCType.REF_CURSOR. See also StoredProcedureQuerySender.
      DEPRECATED: Type LIST can also be used in larva test to Convert a List to an xml-string (<items><item>...</item><item>...</item></items>)

    • MAP

      @Deprecated public static final ParameterType MAP
      Deprecated.
      (Used in larva only) Converts a Map<String, String> object to a xml-string (<items><item name='...'>...</item><item name='...'>...</item></items>)

  • Field Details

    • requiresTypeConversion

      public final boolean requiresTypeConversion

  • Method Details

    • values

      public static ParameterType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ParameterType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getTypeClass

      public Class<? extends IParameter> getTypeClass()