Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.flexstor.common.data.ejb.search
Class AssetTree  view AssetTree download AssetTree.java

java.lang.Object
  extended bycom.flexstor.common.util.FlexNode
      extended bycom.flexstor.common.data.ejb.search.AssetTree
All Implemented Interfaces:
java.io.Serializable

public class AssetTree
extends com.flexstor.common.util.FlexNode

For a single disguise, this object is filled by the SearchResultRetrievalBean.getAssetsStructure() method with information about some assets in a tree-like structure. The root element of the tree contains the disguise id, the next level contains the element bucket and from there downwards are all assets in their hierarchical structure (primary parent, child, parent, child, etc).


Field Summary
static int DISGUISE
          Constant to denote a disguise node (the root node)
private  long lNodeId
          For the root node, this will be the disguise id, for first-level nodes this will be the element id, for the rest, it will be the asset ids.
private  int nNodeRole
          Defines the asset role for this node, only if this is an ASSET node; otherwise it will be set to -1.
private  int nNodeType
          Defines whether this is a node representing the root node, an element or an asset.
 
Fields inherited from class com.flexstor.common.util.FlexNode
 
Constructor Summary
AssetTree(long lId, int nType)
          Constructor to create a DISGUISE, ELEMENT or ASSET node.
 
Method Summary
 void addChild(com.flexstor.common.util.FlexNode n)
          Adds a node as a child of this one.
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
 long getId()
           
 AssetTree getNode(long lId, int nType)
          Starting at root, parse the tree looking for a specific node, based on the record id and type pecified
 int getRole()
           
 int getType()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 boolean isAsset()
           
 boolean isChildAsset()
           
 boolean isDisguise()
           
 boolean isElement()
           
 boolean isParentAsset()
           
 boolean isPrimaryAsset()
           
 void setParent(com.flexstor.common.util.FlexNode n)
          Sets a node as the parent of this one.
 void setRole(int nRole)
          Set the role for an ASSET node; if this is not an ASSET node, the role will be set to -1
 
Methods inherited from class com.flexstor.common.util.FlexNode
dispose, getChildren, getChildrenCount, getChildrenFlattened, getParent, getRoot, hasChildren, removeAllChildren, removeChild
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISGUISE

public static final int DISGUISE
Constant to denote a disguise node (the root node)

See Also:
Constant Field Values

lNodeId

private long lNodeId
For the root node, this will be the disguise id, for first-level nodes this will be the element id, for the rest, it will be the asset ids.


nNodeType

private int nNodeType
Defines whether this is a node representing the root node, an element or an asset. It uses the constants in com.flexstor.common.constants. BucketConstantsI class for identifying an element and an asset, and AssetTree.DISGUISE for the root level


nNodeRole

private int nNodeRole
Defines the asset role for this node, only if this is an ASSET node; otherwise it will be set to -1.

Constructor Detail

AssetTree

public AssetTree(long lId,
                 int nType)
Constructor to create a DISGUISE, ELEMENT or ASSET node. Attempting to create any other type of node will throw a runtime IllegalArgumentException

Method Detail

getId

public long getId()

getType

public int getType()

setRole

public void setRole(int nRole)
Set the role for an ASSET node; if this is not an ASSET node, the role will be set to -1


getRole

public int getRole()

isDisguise

public boolean isDisguise()

isElement

public boolean isElement()

isAsset

public boolean isAsset()

isPrimaryAsset

public boolean isPrimaryAsset()

isChildAsset

public boolean isChildAsset()

isParentAsset

public boolean isParentAsset()

setParent

public void setParent(com.flexstor.common.util.FlexNode n)
Sets a node as the parent of this one. If a parent was already set, this method will set a new parent. The previous parent-child relationship will be removed. Three basic rules will be checked prior to assigning a parent to the current node: - If the current node is a DISGUISE, it cannot have a parent node. - If the current node is an ELEMENT, the parent node must be a DISGUISE. - If the current node is an ASSET, the parent node must be either an ELEMENT or another ASSET. If any of the above rules is broken, a runtime IllegalArgumentException will be thrown indicating so in the message.


addChild

public void addChild(com.flexstor.common.util.FlexNode n)
Adds a node as a child of this one. Multiple children can be added to a node. Three basic rules will be checked prior to assigning a parent to the current node: - If the current node is a DISGUISE, the child node must be an ELEMENT. - If the current node is an ELEMENT, the child node must be an ASSET. If the element has a child already assigned to it, an IllegalArgumentException is thrown indicating the operation is not possible. - If the current node is an ASSET, the child node must be an ASSET. If any of the above rules is broken, a runtime IllegalArgumentException will be thrown indicating so in the message.


getNode

public AssetTree getNode(long lId,
                         int nType)
Starting at root, parse the tree looking for a specific node, based on the record id and type pecified


equals

public boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)