org.mdi.bootstrap

Class MetaData

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

org.mdi.bootstrap.MetaData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class MetaData
extends java.util.HashMap<java.lang.String,java.lang.Object>

Hold informations about any panel in the application.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MetaData() Default constructor.
MetaData(int initialCapacity) Create a MetaData with a initial capacity.
MetaData(java.util.Map<java.lang.String,java.lang.Object> map) Create a MetaData with a initial Map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	getBooleanValue(java.lang.String key) Return true or false if the key associated value is a Boolean, or false if the key does not exist or the value is not a Boolean.
MetaData	getCompatibilityMetaData() Return a MetaData that contains only the keys that are useful for compatibility check, that is, stripped of all non compatible keys.
int	getIntegerValue(java.lang.String key) Return the int value associated with the key, or -1 if the key does not exist or the value is not an Integer.
java.lang.String	getStringValue(java.lang.String key) Return the String value associated with the key, or null if the key does not exist or the value is not a String.
int	hashCode() The hashcode of a MetaData is the same as the HashMap hashcode, except that it does not take into account not comparable keys (see isComparableKey(String)).
static boolean	isComparableKey(java.lang.String key) Return true if a key will be used for comparisons.
boolean	isCompatibleWith(MetaData meta) Same as isCompatibleWith(MetaData, boolean), with only partial compatibility.
boolean	isCompatibleWith(MetaData meta, boolean complete) Look if two MetaDatas are compatible.
boolean	isEqual(java.lang.String key, java.lang.Object value) Return true if the key value for this MetaData is equal to another value.
static boolean	isUserKey(java.lang.String key) Return true if a key is a user key, so it can be presented to the user.
static void	setNotComparableKeys(java.util.List<java.lang.String> notCompKeyList) Set specific keys which will not be used for the comparison.
static void	setSpecificKeys(java.util.List<java.lang.String> notCompKeyList, java.util.List<java.lang.String> notUserKeysList) Set specific keys which will have a specific behavior for all Metadatas.
static void	setUserKeys(java.util.List<java.lang.String> notUserKeysList) Set user keys.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetaData

public MetaData()

Default constructor.

MetaData

public MetaData(int initialCapacity)

Create a MetaData with a initial capacity.

Parameters:

initialCapacity - the initial capacity

MetaData

public MetaData(java.util.Map<java.lang.String,java.lang.Object> map)

Create a MetaData with a initial Map.

Parameters:

map - the initial Map

Method Detail

setNotComparableKeys

public static void setNotComparableKeys(java.util.List<java.lang.String> notCompKeyList)

Set specific keys which will not be used for the comparison.

Parameters:

notCompKeyList - the List of keys which will not be used for MetaData comparisons

See Also:

isComparableKey(String)

setUserKeys

public static void setUserKeys(java.util.List<java.lang.String> notUserKeysList)

Set user keys.

Parameters:

notUserKeysList - the List of keys which must not be presented to the user

setSpecificKeys

public static void setSpecificKeys(java.util.List<java.lang.String> notCompKeyList,
                                   java.util.List<java.lang.String> notUserKeysList)

Set specific keys which will have a specific behavior for all Metadatas.

Parameters:

notCompKeyList - the List of keys which will not be used for MetaData comparisons

notUserKeysList - the List of keys which must not be presented to the user

See Also:

isUserKey(String), isComparableKey(String)

isUserKey

public static boolean isUserKey(java.lang.String key)

Return true if a key is a user key, so it can be presented to the user.

Parameters:

key - the key

Returns:

true if the key is a user key

isComparableKey

public static boolean isComparableKey(java.lang.String key)

Return true if a key will be used for comparisons.

Parameters:

key - the key

Returns:

true if the key will be used for comparisons

getBooleanValue

public boolean getBooleanValue(java.lang.String key)

Return true or false if the key associated value is a Boolean, or false if the key does not exist or the value is not a Boolean.

Parameters:

key - the key

Returns:

true if the key associated value is a Boolean, or false if the key does not exist or the value is not a Boolean

isEqual

public boolean isEqual(java.lang.String key,
                       java.lang.Object value)

Return true if the key value for this MetaData is equal to another value. Cases where one of the values is null are taken into account.

Parameters:

key - the key

value - the value to compare

Returns:

true if the key value for this MetaData is equal to the specified value

getStringValue

public java.lang.String getStringValue(java.lang.String key)

Return the String value associated with the key, or null if the key does not exist or the value is not a String.

Parameters:

key - the key

Returns:

the String value associated with the key, or null if the key does not exist or the value is not a String

getIntegerValue

public int getIntegerValue(java.lang.String key)

Return the int value associated with the key, or -1 if the key does not exist or the value is not an Integer.

Parameters:

key - the key

Returns:

the int value associated with the key, or null if the key does not exist or the value is not an Integer

hashCode

public int hashCode()

The hashcode of a MetaData is the same as the HashMap hashcode, except that it does not take into account not comparable keys (see isComparableKey(String)).

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

hashCode in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Returns:

the hashCode

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

equals in class java.util.AbstractMap<java.lang.String,java.lang.Object>

getCompatibilityMetaData

public MetaData getCompatibilityMetaData()

Return a MetaData that contains only the keys that are useful for compatibility check, that is, stripped of all non compatible keys.

Returns:

a MetaData stripped of all non compatible keys

isCompatibleWith

public boolean isCompatibleWith(MetaData meta)

Same as isCompatibleWith(MetaData, boolean), with only partial compatibility. Only the keys of the MetaData to compare must match, meaning that there can be additional keys in this MetaData.

Parameters:

meta - the MetaData to compare with

Returns:

true if this MetaData is compatible with another MetaData

isCompatibleWith

public boolean isCompatibleWith(MetaData meta,
                                boolean complete)

Look if two MetaDatas are compatible. Compatibility is slightly different from Object equality (which is of course also supported by MetaDatas) :

• Contrary to equality, compatibility is -NOT- transitive
• the MetaData m1 is compatible with MetaData m2 (m1.isCompatible(m2)) if and only if :
  • All the not boolean attributes of m2 exist in m1 and have equal values
  • All the boolean attributes of m2 that are true exist in m1 and have equal values

Examples

For example, if this MetaData contains only this following property :

• "test" > true

Only MetaDatas that contain the "test" property with the associated true value will be compatible.

Parameters:

meta - the MetaData to compare with

complete - true if there must be equality for the MetaData keys, meaning that all properties in each MetaData must match, false if only the keys of the MetaData to compare must match

Returns:

true if this MetaData is compatible with another MetaData