DomainUtils (enterprisemath-utils 2.4.0 API)

java.lang.Object
- com.enterprisemath.utils.DomainUtils

```
public class DomainUtils
extends Object
```
Contains static method which simplifies the manipulation with domain objects.

Author:

radek.hecl

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,Object>`	`buildEnvironmentFromXml(Node node, Map<String,? extends Object> environment)` Builds the environment from the specified xml node.
`static Object`	`buildObject(String className, Map<String,? extends Object> configuration)` Builds the object with the specified configuration.
`static Object`	`buildObjectFromXml(Node node, Map<String,? extends Object> environment)` Builds object from the specified xml node.
`static <T> Map<String,Object>`	`convertPropertyMapIntoVelocityModel(Map<String,T> properties)` Converts property map into the velocity model.
`static Date`	`copyDate(Date source)` Null safe copy date function.
`static Document`	`createDocumentFromXmlBytes(byte[] bytes)` Creates the document from a given XML file, specified by bytes.
`static Document`	`createDocumentFromXmlFile(File file)` Creates the document from a given XML file.
`static <K,V> Map<K,V>`	`createMap(K key, V val, Object... data)` Wrapper function to create map from single line.
`static <T> Set<T>`	`createSet(T... a)` Wrapper function around java.util.Arrays.asList to create a set of objects.
`static Object`	`getPropertyByEnum(Object obj, Enum<?> enm)` Returns object property by the specified enumeration name.
`static <K,V> Map<K,V>`	`mergeMaps(Map<K,V>... maps)` Merges several maps into one.
`static boolean`	`safeEquals(Object obj1, Object obj2)` Null safe equals method.
`static <T> List<T>`	`softCopyList(Collection<T> source)` Null safe function for creating a soft copy of the list.
`static <K,V> Map<K,V>`	`softCopyMap(Map<K,V> source)` Null safe function for creating a soft copy of the map.
`static <T> Set<T>`	`softCopySet(Collection<T> source)` Null safe function for creating a soft copy of the set.
`static <K,V> SortedMap<K,V>`	`softCopySortedMap(Map<K,V> source)` Null safe function for creating a soft copy of the sorted map.
`static <T extends Comparable<?>> SortedSet<T>`	`softCopySortedSet(Collection<T> source)` Null safe function for creating a soft copy of the sorted set.
`static <T> List<T>`	`softCopyUnmodifiableList(Collection<T> source)` Null safe function for creating a unmodifiable soft copy of the list.
`static <K,V> Map<K,V>`	`softCopyUnmodifiableMap(Map<K,V> source)` Null safe function for creating an unmodifiable soft copy of the map.
`static <T> Set<T>`	`softCopyUnmodifiableSet(Collection<T> source)` Null safe function for creating an unmodifiable soft copy of the set.
`static <K,V> SortedMap<K,V>`	`softCopyUnmodifiableSortedMap(Map<K,V> source)` Null safe function for creating an unmodifiable soft copy of the sorted map.
`static <T extends Comparable<?>> SortedSet<T>`	`softCopyUnmodifiableSortedSet(Collection<T> source)` Null safe function for creating an unmodifiable soft copy of the sorted set.
`static <T> List<List<T>>`	`splitIntoLists(Collection<T> source, int max)` Takes the collection and splits it into the several lists.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copyDate
```
public static Date copyDate(Date source)
```
    Null safe copy date function.
    
    Parameters:
    
    source - source date, can be null
    
    Returns:
    
    copy of the source date or null if source is null
  - softCopyList
```
public static <T> List<T> softCopyList(Collection<T> source)
```
    Null safe function for creating a soft copy of the list. It the source is null, then empty list will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection
    
    Returns:
    
    soft copy of the source object
  - softCopyUnmodifiableList
```
public static <T> List<T> softCopyUnmodifiableList(Collection<T> source)
```
    Null safe function for creating a unmodifiable soft copy of the list. It the source is null, then empty list will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection
    
    Returns:
    
    soft copy of the source object
  - softCopySet
```
public static <T> Set<T> softCopySet(Collection<T> source)
```
    Null safe function for creating a soft copy of the set. If the source is null, then empty set will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection
    
    Returns:
    
    soft copy of the source object
  - softCopyUnmodifiableSet
```
public static <T> Set<T> softCopyUnmodifiableSet(Collection<T> source)
```
    Null safe function for creating an unmodifiable soft copy of the set. If the source is null, then empty set will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection
    
    Returns:
    
    soft copy of the source object
  - softCopySortedSet
```
public static <T extends Comparable<?>> SortedSet<T> softCopySortedSet(Collection<T> source)
```
    Null safe function for creating a soft copy of the sorted set. If the source is null, then empty set will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection, but elements must
    
    Returns:
    
    soft copy of the source object
  - softCopyUnmodifiableSortedSet
```
public static <T extends Comparable<?>> SortedSet<T> softCopyUnmodifiableSortedSet(Collection<T> source)
```
    Null safe function for creating an unmodifiable soft copy of the sorted set. If the source is null, then empty set will be returned.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source object, can be any collection, but elements must
    
    Returns:
    
    soft copy of the source object
  - softCopyMap
```
public static <K,V> Map<K,V> softCopyMap(Map<K,V> source)
```
    Null safe function for creating a soft copy of the map. If the source is null, then empty map will be returned.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    source - source object
    
    Returns:
    
    soft copy of the source object
  - softCopyUnmodifiableMap
```
public static <K,V> Map<K,V> softCopyUnmodifiableMap(Map<K,V> source)
```
    Null safe function for creating an unmodifiable soft copy of the map. If the source is null, then empty map will be returned.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    source - source object
    
    Returns:
    
    soft copy of the source object
  - softCopySortedMap
```
public static <K,V> SortedMap<K,V> softCopySortedMap(Map<K,V> source)
```
    Null safe function for creating a soft copy of the sorted map. If the source is null, then empty map will be returned.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    source - source object
    
    Returns:
    
    soft copy of the source object
  - softCopyUnmodifiableSortedMap
```
public static <K,V> SortedMap<K,V> softCopyUnmodifiableSortedMap(Map<K,V> source)
```
    Null safe function for creating an unmodifiable soft copy of the sorted map. If the source is null, then empty map will be returned.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    source - source object
    
    Returns:
    
    soft copy of the source object
  - mergeMaps
```
public static <K,V> Map<K,V> mergeMaps(Map<K,V>... maps)
```
    Merges several maps into one. If there is no map to merge, then returns empty map. If there is at least one map, then takes elements form the first, then apply from the second and so on. Examples (in JSON notation):
    - {"a" : 1} + {"b" : 2} => {"a" : 1, "b" : 2}
    - {"a" : 1} + {"a" : 2} => {"a" : 2}
    - {"a" : 1} + {"b" : 2} + {"a" : "hello"} => {"a" : "hello", "b" : 2}
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    maps - maps to merge
    
    Returns:
    
    merged map
  - createSet
```
public static <T> Set<T> createSet(T... a)
```
    Wrapper function around java.util.Arrays.asList to create a set of objects.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    a - objects
    
    Returns:
    
    created set
  - createMap
```
public static <K,V> Map<K,V> createMap(K key,
                                       V val,
                                       Object... data)
```
    Wrapper function to create map from single line.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    key - first key
    
    val - first value
    
    data - array with other keys and values, array goes [key1, value1, key2, value2...] and it is responsibility of the caller to take care about class types
    
    Returns:
    
    created map
  - splitIntoLists
```
public static <T> List<List<T>> splitIntoLists(Collection<T> source,
                                               int max)
```
    Takes the collection and splits it into the several lists. Every of these lists has maximum number of elements which is less or equal to the max parameters. If source collection has some duplicated elements, then all of them stays there. If source collection is null or empty, then list with no sub lists will be returned. The ordering within the split lists is the same as within the source collection.
    
    Type Parameters:
    
    T - inner object type
    
    Parameters:
    
    source - source collection
    
    max - maximum allowed number of elements per one list, must be positive number
    
    Returns:
    
    source collection split into lists
  - createDocumentFromXmlFile
```
public static Document createDocumentFromXmlFile(File file)
```
    Creates the document from a given XML file.
    
    Parameters:
    
    file - file to parse
    
    Returns:
    
    created DOM document
  - createDocumentFromXmlBytes
```
public static Document createDocumentFromXmlBytes(byte[] bytes)
```
    Creates the document from a given XML file, specified by bytes.
    
    Parameters:
    
    bytes - bytes containing file to parse
    
    Returns:
    
    created DOM document
  - getPropertyByEnum
```
public static Object getPropertyByEnum(Object obj,
                                       Enum<?> enm)
```
    Returns object property by the specified enumeration name. First searches for getter which starting with "get". If this getter is not presented, then search for the one which starting with "is". Examples of getters for a specified enumeration:
    - ID => getId(), isId()
    - EVENT_TIMESTAMP => getEventTimestamp(), isEventTimestamp()
    If getter is presented, then returns the value. Note: This method uses reflection, so speed is not great.
    Parameters:
    
    obj - object from which property should be obtained
    
    enm - enumeration which will be used to find the property
    
    Returns:
    
    value of the property
  - safeEquals
```
public static boolean safeEquals(Object obj1,
                                 Object obj2)
```
    Null safe equals method. Returns true if both objects are null or equals each other. This method expects equals method to be well defined (reflexivity, symmetricity, transitivity) in both objects.
    
    Parameters:
    
    obj1 - first object
    
    obj2 - second object
    
    Returns:
    
    true if both objects are null or if they equals, false otherwise
  - convertPropertyMapIntoVelocityModel
```
public static <T> Map<String,Object> convertPropertyMapIntoVelocityModel(Map<String,T> properties)
```
    Converts property map into the velocity model. This means deep conversion of these property key types is done.
    - Properties with key in XX format are converted as they are.
    - Properties with key in XX.YY format are converted into map XX = {YY}
    - Properties with key in XX[NUM] format are converted into list
    - Properties with key in XX[NUM].YY format are converted into list of maps
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    properties - properties to be converted
    
    Returns:
    
    velocity model
  - buildObject
```
public static Object buildObject(String className,
                                 Map<String,? extends Object> configuration)
```
    Builds the object with the specified configuration.
    
    Parameters:
    
    className - class name of the result object. This class must be public and have inner static class called Builder which contains public default constructor and public method build. Result of the build method is returned from this method.
    
    configuration - configuration for the builder. Keys are property names. Values are list of objects. If there is a method set + upperCaseFirst(key), then this method is called. Otherwise exception is thrown.
    
    Returns:
    
    created object
  - buildObjectFromXml
```
public static Object buildObjectFromXml(Node node,
                                        Map<String,? extends Object> environment)
```
    Builds object from the specified xml node. Xml node has the following structure:
    <object> <class>org.netwia.ObjectClass</class> <configuration> <property> <name>property1</name> <type>String</type> <value>value1</value> </property> </configuration> </object>
    Where object class is any class which is following the builder pattern. Configuration block allows to have multiple properties. Supported property types are String, Double, Float, Long, Integer, Byte, Boolean, Enumeration and Dependency. In case of Enumeration, value is fully qualified value of the enumeration. In case of Dependency type, value must match key in the specified environment.
    
    Parameters:
    
    node - XML node to be parsed, expected to be the object node specified in the structure
    
    environment - environment
    
    Returns:
    
    created object
    
    Throws:
    
    IndexOutOfBoundsException - in case of Dependency property points to the non existing key in the specified environment
  - buildEnvironmentFromXml
```
public static Map<String,Object> buildEnvironmentFromXml(Node node,
                                                         Map<String,? extends Object> environment)
```
    Builds the environment from the specified xml node. Environment is map of string to object where key is unique name of the object. Result environment contains the originally specified environment plus the new objects from xml. Xml node cannot contain the name which is already included in the original environment. In such cases exception is thrown. Objects can refer each other with non-circular references. Example of xml:
    <environment>
      <object>
        <name>unique-object-name</object>
        ... class and configuration same as in buildObjectFromXml
      </object>
      ... other objects
    </environment>
    
    Parameters:
    
    node - xml node to parse
    
    environment - original environment which will be used for dependencies and included in the created one
    
    Returns:
    
    created environment
    
    Throws:
    
    IndexOutOfBoundsException - in case of Dependency property points to the non existing key within the specified environment and other objects from xml
    
    IllegalArgumentException - if name from xml is duplicated or points to the existing object in the environment

Class DomainUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyDate

softCopyList

softCopyUnmodifiableList

softCopySet

softCopyUnmodifiableSet

softCopySortedSet

softCopyUnmodifiableSortedSet

softCopyMap

softCopyUnmodifiableMap

softCopySortedMap

softCopyUnmodifiableSortedMap

mergeMaps

createSet

createMap

splitIntoLists

createDocumentFromXmlFile

createDocumentFromXmlBytes

getPropertyByEnum

safeEquals

convertPropertyMapIntoVelocityModel

buildObject

buildObjectFromXml

buildEnvironmentFromXml