Package com.highdeal.iec

Interface DataCollection

All Superinterfaces:
com.highdeal.hci.XMLMarshallable
public interface DataCollection extends com.highdeal.hci.XMLMarshallable
This Java interface represents a data collection that is processed by a running Import/Export Connector (IEC) application accordingly to your customized JavaTask; Data is mapped with keys.

For better performance, the interface provides some methods that allow the collection to be reused to limit the count of the instance creation. An instance of the DataCollection class is a set of pairs (key, value) in which the value can be a Boolean, string, date or number. A key is unique, but two keys can have the same value.

Example

The keys k1 and k2 can have the value TRUE that is a Boolean.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAll(Map<String,Object> props)
    Adds the objects of the specified properties to this collection.
    void
    clear()
    Clears the data collection so that it contains no key and UID.
    void
    decant(DataCollection collectionToFill)
    This method decants its members in the specified collectionToFill.
    boolean
    equalsDC(DataCollection dc)
    Compares to the specified data collection, property by property.
    Object
    get(String key)
    Searches for an Object with the specified key in this collection.
    Boolean
    getBoolean(String key)
    Searches for a Boolean with the specified key in this data collection.
    long
    getCreationNumber()
    Returns the creation number of the DataCollection.
    Date
    getDate(String key)
    Searches for a Date with the specified key in this collection.
    Map<String,Object>
    getMap()
    Returns a map that contains the keys and the values.
    BigDecimal
    getNumber(String key)
    Searches for a Number with the specified key in this data collection.
    Resource
    getResource(String key)
    Searches for a resource with the specified key in this collection.
    String
    getString(String key)
    Searches for a String with the specified key in this collection.
    String
    getUID()
    Returns the UID of the DataCollection.
    boolean
    isReusable()
    Returns true if this instance of DataCollection is no more shared by threads, false otherwise.
    Set<String>
    keys()
    Returns all the keys of the collection.
    void
    set(String key, Object data)
    Maps the specified key to the specified Object in this collection; The Object can be retrieved by calling the get(java.lang.String) method with a key that is equal to the original key.
    void
    setBoolean(String key, Boolean data)
    Maps the specified key to the specified Boolean in this data collection; The Boolean can be retrieved by calling the getBoolean(java.lang.String) method with a key that is equal to the original key.
    void
    setCreationNumber(long number)
    Sets the creation number of the DataCollection.
    void
    setDate(String key, Date data)
    Maps the specified key to the specified Date in this collection; The Date can be retrieved by calling the getDate(java.lang.String) method with a key that is equal to the original key.
    void
    setNumber(String key, BigDecimal data)
    Maps the specified key to the specified BigDecimal in this collection; The BigDecimal can be retrieved by calling the getNumber(java.lang.String) method with a key that is equal to the original key.
    void
    setResource(String key, Resource data)
    Maps the specified key to the specified resource in this data collection; The resource can be retrieved by calling the getResource(java.lang.String) method with a key that is equal to the original key.
    void
    setReusable(boolean flag)
    Sets the DataCollection reusable.
    void
    setString(String key, String data)
    Maps the specified key to the specified String in this collection; The String can be retrieved by calling the getString(java.lang.String) method with a key that is equal to the original key.
    void
    setUID(String uid)
    Sets the UID of the DataCollection.

    Methods inherited from interface com.highdeal.hci.XMLMarshallable

    addCharacterData, addChild, marshal, setAttributes

  • Method Details

    • setUID

      void setUID(String uid)
      Sets the UID of the DataCollection.

    • getUID

      String getUID()
      Returns the UID of the DataCollection.

    • getCreationNumber

      long getCreationNumber()
      Returns the creation number of the DataCollection.

    • setCreationNumber

      void setCreationNumber(long number)
      Sets the creation number of the DataCollection.

    • getBoolean

      Boolean getBoolean(String key)
      Searches for a Boolean with the specified key in this data collection.
      Returns:
      The Boolean in this collection with the specified key value if it exists, null otherwise

    • setBoolean

      void setBoolean(String key, Boolean data)
      Maps the specified key to the specified Boolean in this data collection; The Boolean can be retrieved by calling the getBoolean(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • getString

      String getString(String key)
      Searches for a String with the specified key in this collection.
      Returns:
      The String in this collection with the specified key value if it exists, null otherwise

    • setString

      void setString(String key, String data)
      Maps the specified key to the specified String in this collection; The String can be retrieved by calling the getString(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • getDate

      Date getDate(String key)
      Searches for a Date with the specified key in this collection.
      Returns:
      The Date in this collection with the specified key value if it exists, null otherwise

    • setDate

      void setDate(String key, Date data)
      Maps the specified key to the specified Date in this collection; The Date can be retrieved by calling the getDate(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • getNumber

      BigDecimal getNumber(String key)
      Searches for a Number with the specified key in this data collection.
      Returns:
      The Number in this collection with the specified key value if it exists, null otherwise

    • setNumber

      void setNumber(String key, BigDecimal data)
      Maps the specified key to the specified BigDecimal in this collection; The BigDecimal can be retrieved by calling the getNumber(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • getResource

      Resource getResource(String key)
      Searches for a resource with the specified key in this collection.
      Returns:
      The resource in this collection with the specified key value if it exists, null otherwise

    • setResource

      void setResource(String key, Resource data)
      Maps the specified key to the specified resource in this data collection; The resource can be retrieved by calling the getResource(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • get

      Object get(String key)
      Searches for an Object with the specified key in this collection.
      Returns:
      The Object in this collection with the specified key value if it exists, null otherwise

    • set

      void set(String key, Object data)
      Maps the specified key to the specified Object in this collection; The Object can be retrieved by calling the get(java.lang.String) method with a key that is equal to the original key.
      Parameters:
      key - The key
      data - The value

    • keys

      Set<String> keys()
      Returns all the keys of the collection.

    • setReusable

      void setReusable(boolean flag)
      Sets the DataCollection reusable.

    • isReusable

      boolean isReusable()
      Returns true if this instance of DataCollection is no more shared by threads, false otherwise. If it is the case, you can reset the collection instance and reuse it without any problems. This is very useful for multithreaded processes.

    • decant

      void decant(DataCollection collectionToFill)
      This method decants its members in the specified collectionToFill.

      Note

      This instance should not use its members.

      Parameters:
      collectionToFill - The target data collection

    • clear

      void clear()
      Clears the data collection so that it contains no key and UID.

    • equalsDC

      boolean equalsDC(DataCollection dc)
      Compares to the specified data collection, property by property.

    • getMap

      Map<String,Object> getMap()
      Returns a map that contains the keys and the values.

    • addAll

      void addAll(Map<String,Object> props)
      Adds the objects of the specified properties to this collection.
      Parameters:
      props - The properties from which the objects are extracted