com.bmc.arsys.api
Class Entry

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<K,V>
          java.util.LinkedHashMap<Integer,Value>
              com.bmc.arsys.api.Entry

All Implemented Interfaces:

Serializable, Cloneable, Map<Integer,Value>

public class Entry
extends LinkedHashMap<Integer,Value>
implements Serializable

The Entry class defines the entry of ARSystem forms. It is a map that takes field id as the map key and field value Value as the map value

See Also:

Serialized Form

Constructor Summary

Entry()

Entry(Map<? extends Integer,? extends Value> m)

Entry(SortedMap<Integer,? extends Value> m)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getEntryId() return the entry id of this entry object
String	getEntryIdWithNoSeparator() return the entry id with separator characters being stripped out.
String	getKey() return the key (entry id) of this entry object
static String	prepareEntryId(Object[] var) Reserved for internal use.
Value	put(Integer key, Value value) Associates the specified value (field value) with the specified key (field id) in the entry object.
void	putAll(Map<? extends Integer,? extends Value> map) Copies all of the mappings from the specified map to this entry object.
void	setEntryId(String entryId) set the provided entry id to the entry object
static String[]	splitEntryId(String entryId) Split the given entryId string into a string array.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get

Methods inherited from class java.util.HashMap

containsKey, entrySet, isEmpty, keySet, remove, size, values

Methods inherited from class java.util.AbstractMap

hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, hashCode, isEmpty, keySet, remove, size, values

Constructor Detail

Entry

public Entry()

Entry

public Entry(Map<? extends Integer,? extends Value> m)

Entry

public Entry(SortedMap<Integer,? extends Value> m)

Method Detail

getKey

public String getKey()

return the key (entry id) of this entry object

getEntryId

public String getEntryId()

return the entry id of this entry object

getEntryIdWithNoSeparator

public String getEntryIdWithNoSeparator()

return the entry id with separator characters being stripped out. The separator characters ('|') are used in join entry id to separate the ids from each base form. This is because that a join form entry id is a composition of all base form entry ids. Separator character is also used in vendor form entry id in the case that the entry id exceeds the maximum entry id size Constants.AR_MAX_ENTRYID_SIZE. Therefore, for a regular form, this method is equivalent to getEntryId

setEntryId

public void setEntryId(String entryId)

set the provided entry id to the entry object

Parameters:

entryId -

splitEntryId

public static String[] splitEntryId(String entryId)

Split the given entryId string into a string array. The split is based on the separator character '|' and the size of a maximum entry id can be Constants.AR_MAX_ENTRYID_SIZE. The output is a string array with each string to be equal or less than Constants.AR_MAX_ENTRYID_SIZE.

prepareEntryId

public static String prepareEntryId(Object[] var)

Reserved for internal use.

Parameters:

var -

Returns:

a populated String object

clone

public Object clone()

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class HashMap<Integer,Value>

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Specified by:

equals in interface Map<Integer,Value>

Overrides:

equals in class AbstractMap<Integer,Value>

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

put

public Value put(Integer key,
                 Value value)

Associates the specified value (field value) with the specified key (field id) in the entry object.

Specified by:

put in interface Map<Integer,Value>

Overrides:

put in class HashMap<Integer,Value>

putAll

public void putAll(Map<? extends Integer,? extends Value> map)

Copies all of the mappings from the specified map to this entry object.

Specified by:

putAll in interface Map<Integer,Value>

Overrides:

putAll in class HashMap<Integer,Value>