CloudNode (IDBS2)

java.lang.Object
- it.unimi.dico.islab.idbs2.cloud.CloudNode

```
public class CloudNode
extends Object
```
Representation of a node of the cloud providing methods for content's management. A node N is composed by a set of resources (class Resource), a prominence value and e set of edges (class CloudNode pointing other nodes. This class also contains the representation of the essential.
An essential is formally a couple <K,T> where K is a set of keywords (related to this node) associated with a relevance value and T is a set of types (associated with this node) associated with a relevance value.

In addiction it contains Hibernate information for cloud database synchronization.

Author:

Vegeziel

See Also:
Cloud, Resource, CloudEdge, KeywordRelevance, TypeRelevance

Field Summary

Fields
Modifier and Type Field and Description

double DEFAULT_RESOURCE_RELEVANCE

Fields
Modifier and Type	Field and Description
`double`	`DEFAULT_RESOURCE_RELEVANCE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CloudNode()

Constructors
Modifier	Constructor and Description
`protected`	`CloudNode()`

Method Summary

Methods
Modifier and Type	Method and Description
`CloudEdge`	`addEdge(CloudNode node, double weight)` Adds an edge to the current node.
`KeywordRelevance`	`addEsTerm(Integer termId, String termValue, Double relevance)` Deprecated.
`TypeRelevance`	`addEsType(String classId, Double relevance)` Deprecated.
`KeywordRelevance`	`addKeyword(Integer termId, String termValue, Double relevance)` Add a keyword (represented by the class `EsTerm`) to this node.
`void`	`addProperty(Property p)`
`Resource`	`addResource(String resId, Double relevance)` Create and add a resource (instance of the `Resource` class) to this node.
`Set<Resource>`	`addResources(List<String> resources, List<Double> relevances)` Creates and add a list of resources (instances of the `Resource` class) to this node.
`TypeRelevance`	`addType(String classId, Double relevance)` Add a type (represented by the class `EsType`) to this node.
`void`	`clearEssentials()` Removes all the keywords and types connected to the current `CloudNode`.
`void`	`clearKeywords()` Removes all the keywords connected to the current `CloudNode`.
`void`	`clearTypes()` Removes all the types connected to the current `CloudNode`.
`boolean`	`equals(Object other)`
`Cloud`	`getCloud()` Get the owner cloud (`Cloud` object) of this node.
`double`	`getConfidence()`
`CloudEdge`	`getEdge(CloudNode target)` Get the edge having this node as a source node and the given node as target if such an edge exists.
`Set<CloudEdge>`	`getEdges()` Get the set of edges having this node as a source node.
`Integer`	`getId()` Get the id of the corresponding database persisted object.
`KeywordRelevance`	`getKeyword(String keywordValue)` Search for a keyword connected to this `CloudNode` represented by the keyword value `keywordValue`.
`SortedSet<KeywordRelevance>`	`getKeywords()` Get the set of all keywords associated to this node, ordered by ascending `relevance`.
`double`	`getProminence()` Getter for the prominence value of this node
`Set<Property>`	`getProperties()`
`Set<Resource>`	`getResources()` Get the set of all resources connected to this node.
`double`	`getSimilarity()`
`TypeRelevance`	`getType(String classId)` Search for a type connected to this `CloudNode` represented by the class `classId`.
`SortedSet<TypeRelevance>`	`getTypes()` Get the set of all types associated to this node, ordered by ascending `relevance`.
`int`	`hashCode()`
`boolean`	`removeEdge(CloudNode target)` Removes the edge having this node as source and the node `target` as target (if such and edge exists).
`boolean`	`removeKeyword(KeywordRelevance kr)` Removes the given `KeywordRelevance` from the current `CloudNode`.
`boolean`	`removeKeyword(String keyword)` Search for a keyword connected to this `CloudNode` represented by the `keyword` and removes it.
`void`	`removeProperty(Property p)`
`void`	`removeResources()` Removes all the resources belonging to this `CloudNode`.
`boolean`	`removeType(String classId)` Search for a type connected to this `CloudNode` represented by the class `classId` and removes it.
`boolean`	`removeType(TypeRelevance type)` Removes the given `TypeRelevance` from the current `CloudNode`.
`protected void`	`setCloud(Cloud cl)` Set the owner cloud (`Cloud` object) of this node.
`void`	`setConfidence(double confidence)`
`void`	`setKeywords(SortedSet<KeywordRelevance> keywords)` Set the keywords connected to this node.
`void`	`setProminence(double prominence)` Setter for the prominence value of this node
`void`	`setProperties(Set<Property> properties)`
`protected void`	`setResources(Set<Resource> resources)` Set the resources connected to this node.
`void`	`setSimilarity(double similarity)`
`protected void`	`setTypes(SortedSet<TypeRelevance> types)` Set the types connected to this node.
`String`	`toString()` Returns a string representation of this node.

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

- Field Detail
  - DEFAULT_RESOURCE_RELEVANCE
```
public final double DEFAULT_RESOURCE_RELEVANCE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CloudNode
```
protected CloudNode()
```
- Method Detail
  - addEdge
```
public CloudEdge addEdge(CloudNode node,
                double weight)
```
    Adds an edge to the current node. This method performs the same operation of the Cloud.addEdge method.
    
    Parameters:
    node - the CloudNode to which the edge is directed (the source node is the current node).
    weight - the edge weight.
    
    Returns:
    returns the generated edge (an instance of CloudEdge).
    See Also:
    Cloud.addEdge(CloudNode, CloudNode, double)
  - removeEdge
```
public boolean removeEdge(CloudNode target)
```
    Removes the edge having this node as source and the node target as target (if such and edge exists).
    Parameters:
    target - the target node of the edge to be removed.
    
    Returns:
    true: if the edge this->target exists and has been removed correctly
    false: if the edge this->target has not been found.
  addResource public Resource addResource(String resId, Double relevance) Create and add a resource (instance of the Resource class) to this node. Recalling the fact that a CloudNode is a collection of resources (resulting from a clustering operation), this method is used to put in the node its belonging resources. Parameters: resId - the string representing the knowledge chunk identifier of the inserted resource. relevance - the relevance value of the inserted resource Returns: the generated Resource instance. See Also: Resource addResources public Set<Resource> addResources(List<String> resources, List<Double> relevances) Creates and add a list of resources (instances of the Resource class) to this node. Parameters: resources - a list of resource ids to be included in this node. relevances - a list of relevances values to be associated (respecting the order of the list) to the ids in resources. This parameter could be null: in this case the DEFAULT_RESOURCE_RELEVANCE default value will be used for all resources. Returns: the set of created resources already added to this CloudNode See Also: addResource(String, Double) removeResources public void removeResources() Removes all the resources belonging to this CloudNode. addProperty public void addProperty(Property p) removeProperty public void removeProperty(Property p) getEdge public CloudEdge getEdge(CloudNode target) Get the edge having this node as a source node and the given node as target if such an edge exists. Parameters: target - connected node. Returns: The required CloudEdge object or null if not found. addType public TypeRelevance addType(String classId, Double relevance) Add a type (represented by the class EsType) to this node. Parameters: classId - the identifier of the added type (RDF class). relevance - the relevance of the added type for this node. Returns: the generated type (instance of the EsType class) See Also: TypeRelevance addEsType @Deprecated public TypeRelevance addEsType(String classId, Double relevance) Deprecated. Substituted by the method addType(String, Double). getType public TypeRelevance getType(String classId) Search for a type connected to this CloudNode represented by the class classId. Parameters: classId - the identifier of the required class (e.g., "foaf:Person"). Returns: the TypeRelevance class representing the relevance of the required class for the current CloudNode. removeType public boolean removeType(String classId) Search for a type connected to this CloudNode represented by the class classId and removes it. Parameters: classId - the identifier of the type (e.g., "foaf:Person") that should be removed. Returns: true: if the type has been found and removed false: if the given type has not been found removeType public boolean removeType(TypeRelevance type) Removes the given TypeRelevance from the current CloudNode. Parameters: type - the TypeRelevance object that should be removed. Returns: true: if the type has been found and removed false: if the given type has not been found clearTypes public void clearTypes() Removes all the types connected to the current CloudNode. addKeyword public KeywordRelevance addKeyword(Integer termId, String termValue, Double relevance) Add a keyword (represented by the class EsTerm) to this node. Parameters: termId - the identifier of the added Term in the correlated KC database. termValue - the string representation of the added term. Returns: the generated keyword (instance of the EsTerm class) See Also: KeywordRelevance addEsTerm @Deprecated public KeywordRelevance addEsTerm(Integer termId, String termValue, Double relevance) Deprecated. Substituted by the method addKeyword(Integer, String, Double). getKeyword public KeywordRelevance getKeyword(String keywordValue) Search for a keyword connected to this CloudNode represented by the keyword value keywordValue. Parameters: keywordValue - the keyword of the required KeywordRelevance (e.g., "Computer Science"). Returns: the KeywordRelevance class representing the relevance of the required keyword for the current CloudNode. removeKeyword public boolean removeKeyword(String keyword) Search for a keyword connected to this CloudNode represented by the keyword and removes it. Parameters: keyword - the keyword that should be removed. Returns: true: if the given keyword has been found and removed false: if the given keyword has not been found removeKeyword public boolean removeKeyword(KeywordRelevance kr) Removes the given KeywordRelevance from the current CloudNode. Parameters: kr - the KeywordRelevance object that should be removed. Returns: true: if the given keyword has been found and removed false: if the given keyword has not been found clearKeywords public void clearKeywords() Removes all the keywords connected to the current CloudNode. clearEssentials public void clearEssentials() Removes all the keywords and types connected to the current CloudNode. getEdges public Set<CloudEdge> getEdges() Get the set of edges having this node as a source node. Returns: a set of all edges starting from this node. equals public boolean equals(Object other) Overrides: equals in class Object hashCode public int hashCode() Overrides: hashCode in class Object getResources public Set<Resource> getResources() Get the set of all resources connected to this node. Returns: a set of all resources connected to this node. setResources protected void setResources(Set<Resource> resources) Set the resources connected to this node. Parameters: resources - a set of the resources to be inserted in this node. getProminence public double getProminence() Getter for the prominence value of this node Returns: the prominence value of this node. setProminence public void setProminence(double prominence) Setter for the prominence value of this node Parameters: prominence - the prominence value to be set. getCloud public Cloud getCloud() Get the owner cloud (Cloud object) of this node. Returns: the owner cloud of this node. setCloud protected void setCloud(Cloud cl) Set the owner cloud (Cloud object) of this node. Parameters: cl - the owner cloud of this node. getId public Integer getId() Get the id of the corresponding database persisted object. Returns: the identifier (primary key) of the corresponding row on the relational Hibernate-mapped relational database. getProperties public Set<Property> getProperties() setProperties public void setProperties(Set<Property> properties) getTypes public SortedSet<TypeRelevance> getTypes() Get the set of all types associated to this node, ordered by ascending relevance. Returns: a set of all types (object of EsType class) associated with this node. setTypes protected void setTypes(SortedSet<TypeRelevance> types) Set the types connected to this node. Parameters: types - the set of all types connected with this node. getKeywords public SortedSet<KeywordRelevance> getKeywords() Get the set of all keywords associated to this node, ordered by ascending relevance. Returns: a set of all keywords (object of EsKeyword class) associated with this node. setKeywords public void setKeywords(SortedSet<KeywordRelevance> keywords) Set the keywords connected to this node. Parameters: keywords - the set of all types connected with this node. getSimilarity public double getSimilarity() setSimilarity public void setSimilarity(double similarity) getConfidence public double getConfidence() setConfidence public void setConfidence(double confidence) toString public String toString() Returns a string representation of this node. Overrides: toString in class Object Returns: a string of type "CNode x" where x is the identifier of this cloud node.

Class CloudNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_RESOURCE_RELEVANCE

Constructor Detail

CloudNode

Method Detail

addEdge

removeEdge

addResource

addResources

removeResources

addProperty

removeProperty

getEdge

addType

addEsType

getType

removeType

removeType

clearTypes

addKeyword

addEsTerm

getKeyword

removeKeyword

removeKeyword

clearKeywords

clearEssentials

getEdges

equals

hashCode

getResources

setResources

getProminence

setProminence

getCloud

setCloud

getId

getProperties

setProperties

getTypes

setTypes

getKeywords

setKeywords

getSimilarity

setSimilarity

getConfidence

setConfidence

toString