Package com.arbortext.epic

Interface PropertyMap

All Known Implementing Classes:
PropertyMapImpl
public interface PropertyMap
The PropertyMap interface provides the abstraction of a collection of typed objects associated with string keys.

The items in the PropertyMap are accessible by a string key. The keys attribute is provided to iterate over all entries in the map.

A PropertyMap object can be created using the Application.createPropertyMap factory method. Some AOM methods return PropertyMap objects.

Since:
Epic 4.3

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    TYPE_NUMBER
    The data value is a number.
    static final short
    TYPE_STRING
    The data value is a DOMString.
    static final short
    TYPE_STRINGLIST
    The data value is a StringList object.
    static final short
    TYPE_UNKNOWN
    No data associated with the key.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsKey(String key)
    Tests whether the specified key is contained in the PropertyMap.
    short
    getDataType(String key)
    Returns the type of data associated with the specified key in the PropertyMap.
    StringList
    getKeys()
    Returns a StringList of all keys in the collection, which may be used to iterate over the PropertyMap.
    boolean
    getModified()
    A boolean indicating whether the property map object has been modified in the current session.
    int
    getNumber(String key)
    Returns the integer value data associated with the specified key in the PropertyMap.
    String
    getString(String key)
    Returns the string value data associated with the specified key in the PropertyMap.
    StringList
    getStringList(String key)
    Returns the StringList associated with the specified key in the PropertyMap.
    void
    putNumber(String key, int value)
    Associates a numeric value with a particular key.
    void
    putString(String key, String value)
    Associates a DOMString with a particular key.
    void
    putStringList(String key, StringList value)
    Associates a StringList with a particular key.
    void
    remove(String key)
    Deletes an entry from the PropertyMap.
    void
    setModified(boolean modified)
    A boolean indicating whether the property map object has been modified in the current session.

  • Field Details

    • TYPE_UNKNOWN

      static final short TYPE_UNKNOWN
      No data associated with the key.
      See Also:

    • TYPE_NUMBER

      static final short TYPE_NUMBER
      The data value is a number.
      See Also:

    • TYPE_STRINGLIST

      static final short TYPE_STRINGLIST
      The data value is a StringList object.
      See Also:

    • TYPE_STRING

      static final short TYPE_STRING
      The data value is a DOMString.
      See Also:

  • Method Details

    • getKeys

      StringList getKeys()
      Returns a StringList of all keys in the collection, which may be used to iterate over the PropertyMap.

    • containsKey

      boolean containsKey(String key)
      Tests whether the specified key is contained in the PropertyMap.
      Parameters:
      key - The key to check.
      Returns:
      true if the PropertyMap contains a value for key. false otherwise.

    • getDataType

      short getDataType(String key)
      Returns the type of data associated with the specified key in the PropertyMap.
      Parameters:
      key - The key to examine.
      Returns:
      The type associated with the key. If key is not contained in the PropertyMap, returns TYPE_UNKNOWN.

    • getNumber

      int getNumber(String key)
      Returns the integer value data associated with the specified key in the PropertyMap.
      Parameters:
      key - The key to examine.
      Returns:
      The numeric value associated with the key. If key is not contained in the PropertyMap or the map entry is not a number, returns -1.

    • getString

      String getString(String key)
      Returns the string value data associated with the specified key in the PropertyMap.
      Parameters:
      key - The key to examine.
      Returns:
      The DOMString value associated with the key. If key is not contained in the PropertyMap or the map entry is not a string, returns null.

    • getStringList

      StringList getStringList(String key)
      Returns the StringList associated with the specified key in the PropertyMap.
      Parameters:
      key - The key to examine.
      Returns:
      The StringList value associated with the key. If key is not contained in the PropertyMap or the map entry is not a StringList, returns null.

    • putNumber

      void putNumber(String key, int value)
      Associates a numeric value with a particular key.
      Parameters:
      key - Identifies the value to be replaced.
      value - The new value to be stored.

    • putString

      void putString(String key, String value)
      Associates a DOMString with a particular key.
      Parameters:
      key - Identifies the value to be replaced.
      value - The new value to be stored. If the value is null, the previous value, if any, is deleted from the map.

    • putStringList

      void putStringList(String key, StringList value)
      Associates a StringList with a particular key.
      Parameters:
      key - Identifies the value to be replaced.
      value - The new value to be stored. If the value is null, the previous value, if any, is deleted from the map.

    • remove

      void remove(String key)
      Deletes an entry from the PropertyMap.
      Parameters:
      key - Identifies the item to remove. If the key is not contained in the map, does nothing.

    • getModified

      boolean getModified()
      A boolean indicating whether the property map object has been modified in the current session.
      Since:
      Epic 5.1

    • setModified

      void setModified(boolean modified)
      A boolean indicating whether the property map object has been modified in the current session.
      Since:
      Epic 5.1