public class CollectorDataUtils
extends java.lang.Object
Constructor and Description |
---|
CollectorDataUtils() |
Modifier and Type | Method and Description |
---|---|
static void |
addCollectedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addCollectedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between two entities.
|
static void |
addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between two entities.
|
static void |
addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between some entity data and another entity.
|
static void |
addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
addContainedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addContainedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a containment (contains) relationship between two entities
|
static void |
addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a containment (contains) relationship between two entities
|
static void |
addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static java.util.Map<java.lang.String,java.lang.Object> |
addCustomData(Element element,
java.lang.String dataName,
java.lang.Object data)
Add a custom data entry to some entity data
|
static java.util.Map<java.lang.String,java.lang.Object> |
addCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.lang.Object data)
Add a custom data entry to some entity data
|
static void |
addDependentEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addDependentEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between two entities
|
static void |
addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between two entities
|
static void |
addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
addGenericRelationshipData(java.util.Map<java.lang.String,java.lang.Object> customData,
java.lang.String relationship,
java.util.Map<java.lang.String,java.lang.Object> relationshipData)
Add generic relationship data (e.g.
|
static void |
addGeographicData(Element element,
java.util.Map<java.lang.String,java.lang.Object> data)
Adds geographical data to a given element.
|
static void |
addHostedService(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between an element and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
addHostedService(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between two entities
|
static void |
addHostedService(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static java.lang.Object |
getCustomData(Element element,
java.lang.String dataName)
Get a custom data entry from some element data
|
static java.lang.Object |
getCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName)
Get a custom data entry from some entity data
|
static java.util.Map<java.lang.String,java.lang.Object> |
getGeographicData(Element element)
Return the geographic data for a given element as a single map as required for the
addGeographicData(Element, Map) method |
public static void addCollectedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
element
- The network element that represents the collecting entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addCollectedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) throws CollectorException
element
- The network element that represents the collecting entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
sequence
- An integer representing the sequenceCollectorException
public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
dataHash
- Reference to a map within the store. The collects relationship will be added to this object, which
represents the collecting entityentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) throws CollectorException
dataHash
- Reference to a map within the store. The collects relationship will be added to this object, which
represents the collecting entityentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
sequence
- An integer representing the sequenceCollectorException
public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
entityData
- The map that represents the collecting entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) throws CollectorException
entityData
- The map that represents the collecting entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
sequence
- An integer representing the sequenceCollectorException
public static void addContainedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
element
- The element that represents the containing entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addContainedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) throws CollectorException
element
- The element that represents the containing entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
upwardConnection
- An integer representing the upward connectionCollectorException
public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
dataHash
- Reference to a map within the store. The contains relationship will be added to this object, which
represents the containing entityentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) throws CollectorException
dataHash
- Reference to a map within the store. The contains relationship will be added to this object, which
represents the containing entityentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
upwardConnection
- An integer representing the upward connectionCollectorException
public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
entityData
- The map that represents the collecting entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) throws CollectorException
entityData
- The map that represents the containing entitydataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
upwardConnection
- An integer representing the upward connectionCollectorException
public static java.util.Map<java.lang.String,java.lang.Object> addCustomData(Element element, java.lang.String dataName, java.lang.Object data)
element
- The element data to add the custom data todataName
- The name of the custom data entry (e.g. ranData)data
- The data to storepublic static java.util.Map<java.lang.String,java.lang.Object> addCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.lang.Object data)
entityData
- The entity data to add the custom data todataName
- The name of the custom data entry (e.g. ranData)data
- The data to storepublic static void addDependentEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
element
- The element that represents the entity that is required by the dependentdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addDependentEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) throws CollectorException
element
- The element that represents the entity that is required by the dependentdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
dependencyType
- An integer representing the dependency typeCollectorException
public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
dataHash
- Reference to a map within the store. The relationship will be added to this object, which represents
the entity that is required by the dependententityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) throws CollectorException
dataHash
- Reference to a map within the store. The relationship will be added to this object, which represents
the entity that is required by the dependententityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
dependencyType
- An integer representing the dependency typeCollectorException
public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
entityData
- The map that represents the entity that is required by the dependentdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) throws CollectorException
entityData
- The map that represents the entity that is required by the dependentdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
dependencyType
- An integer representing the dependency typeCollectorException
public static void addGenericRelationshipData(java.util.Map<java.lang.String,java.lang.Object> customData, java.lang.String relationship, java.util.Map<java.lang.String,java.lang.Object> relationshipData) throws CollectorException
customData
- The custom data entry to add the information to (this may be the "root" customData entry, or something
more specific, like a "ranData" entry within customDatarelationship
- The type of relationship (collects, contains, dependency or hostedService)relationshipData
- The relationship data (e.g. the related entity)CollectorException
public static void addGeographicData(Element element, java.util.Map<java.lang.String,java.lang.Object> data)
CollectorValidationUtils.validateGeographicData(Map)
element
- The element to add the geographic data todata
- The geographic location data. Valid fields are:
CollectorValidationUtils.validateGeographicData(Map)
public static void addHostedService(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
element
- The element that represents the entity that is the hostdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addHostedService(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
dataHash
- Reference to a map within the store. The relationship will be added to this object, which represents
the entity that is the hostentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static void addHostedService(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) throws CollectorException
entityData
- The map that represents the entity that is the hostdataName
- What kind of data this relationship pertains to (e.g. ranData). If generic, leave as nullentityDetails
- Identifying details for the related entity @see
CollectorValidationUtils.validateRelationshipData(Map)
CollectorException
public static java.lang.Object getCustomData(Element element, java.lang.String dataName)
element
- The element data from which to fetch the entrydataName
- The name of the custom data entry (e.g. ranData)public static java.lang.Object getCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName)
entityData
- The entity data from which to fetch the entrydataName
- The name of the custom data entry (e.g. ranData)public static java.util.Map<java.lang.String,java.lang.Object> getGeographicData(Element element)
addGeographicData(Element, Map)
methodelement
- The element for which to get the geographic locationCollectorValidationUtils.validateGeographicData(Map)