Cytoscape 3.0.1 API

org.cytoscape.equations
Class IdentDescriptor

java.lang.Object
  extended by org.cytoscape.equations.IdentDescriptor

public final class IdentDescriptor
extends Object

Used to hold a current value for an equation's variable reference.


Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Constructor Summary
IdentDescriptor(Object o)
          Initializes a new IdentDescriptor and provides minimal type translation (from Integer to Long).
 
Method Summary
 Class getType()
          Returns the, possibly adjusted, type of the descriptor as one of the types internally supported by equations.
 Object getValue()
          Returns the value of the descriptor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentDescriptor

public IdentDescriptor(Object o)
Initializes a new IdentDescriptor and provides minimal type translation (from Integer to Long).

Parameters:
o - an object that represents a value for a variable reference
Throws:
NullPointerException - if "o" is null
IllegalArgumentException - if "o" is not a Long, Integer, Double, Boolean nor a String
Method Detail

getType

public Class getType()
Returns the, possibly adjusted, type of the descriptor as one of the types internally supported by equations.

Returns:
the (translated) type of the descriptor

getValue

public Object getValue()
Returns the value of the descriptor.

Returns:
the (translated) value of the descriptor

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.