gov.nih.nci.mageom.domain.BioAssayData.impl
Class BioDataCubeImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
          extended by gov.nih.nci.mageom.domain.BioAssayData.impl.BioDataValuesImpl
              extended by gov.nih.nci.mageom.domain.BioAssayData.impl.BioDataCubeImpl
All Implemented Interfaces:
BioDataCube, BioDataValues, Extendable, java.io.Serializable

public class BioDataCubeImpl
extends BioDataValuesImpl
implements BioDataCube

A three-dimensional cube representation of the data.

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.lang.Object[][][] cube
          Three dimension array, indexed by the three dimensions to provide the data for the
protected  java.lang.String order
          The order to expect the dimension.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
BioDataCubeImpl()
          Default constructor
 
Method Summary
 java.lang.Object[][][] getCube()
          Returns the value of this BioDataCube object's cube attribute.
 java.lang.String getOrder()
          Returns the value of this BioDataCube object's order attribute.
 java.lang.String getSourceType()
           
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 BioDataCube[] searchBioDataCubes(BioDataCubeSearchCriteria criteria)
          Returns an array of BioDataCube objects that satisfy the given BioDataCubeSearchCriteria.
 void setCube(java.lang.Object[][][] p_cube)
          Sets the cube attribute.
 void setOrder(java.lang.String p_order)
          Sets the order attribute.
 void setSourceType(java.lang.String sourceType)
           
 java.lang.String toString()
          Returns a String representation of this object suitable for console display.
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc, java.util.ArrayList fillOutValues)
          Returns an XML representation of the object.
 
Methods inherited from class gov.nih.nci.mageom.domain.BioAssayData.impl.BioDataValuesImpl
searchBioDataValueses
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
getPropertySets, getPropertySetsCount, getSecuredElementId, searchExtendables, setPropertySets, setSecuredElementId
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

cube

protected java.lang.Object[][][] cube
Three dimension array, indexed by the three dimensions to provide the data for the


order

protected java.lang.String order
The order to expect the dimension. The enumeration uses the first letter of the three to represent the six possible orderings.

Constructor Detail

BioDataCubeImpl

public BioDataCubeImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class BioDataValuesImpl

searchBioDataCubes

public BioDataCube[] searchBioDataCubes(BioDataCubeSearchCriteria criteria)
                                 throws gov.nih.nci.common.search.SearchException
Returns an array of BioDataCube objects that satisfy the given BioDataCubeSearchCriteria.

Parameters:
criteria - The BioDataCubeSearchCriteria which represents a query for BioDataCube objects.
Returns:
An array of BioDataCube objects.
Throws:
A - gov.nih.nci.common.search.SearchException if there is a problem searching.
gov.nih.nci.common.search.SearchException

setCube

public void setCube(java.lang.Object[][][] p_cube)
Sets the cube attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioDataCube object.

Parameters:
p_cube - The new value for cube.
See Also:
BioDataCube.getCube()

getCube

public java.lang.Object[][][] getCube()
Description copied from interface: BioDataCube
Returns the value of this BioDataCube object's cube attribute. Description of cube: Three dimension array, indexed by the three dimensions to provide the data for the BioAssayData.

Specified by:
getCube in interface BioDataCube
Returns:
any[][][] The value of cube.
See Also:
BioDataCube.getCube()

setOrder

public void setOrder(java.lang.String p_order)
Sets the order attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioDataCube object.

Parameters:
p_order - The new value for order.
See Also:
BioDataCube.getOrder()

getOrder

public java.lang.String getOrder()
Description copied from interface: BioDataCube
Returns the value of this BioDataCube object's order attribute. Description of order: The order to expect the dimension. The enumeration uses the first letter of the three dimensions to represent the six possible orderings.

Specified by:
getOrder in interface BioDataCube
Returns:
enum {BDQ,BQD,DBQ,DQB,QBD,QDB} The value of order.
See Also:
BioDataCube.getOrder()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Overrides:
toXML in class BioDataValuesImpl

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
Overrides:
toXMLDoc in class BioDataValuesImpl

toXMLProcessor

public org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc,
                                          java.util.ArrayList fillOutValues)
Returns an XML representation of the object. The document is not modified.

Overrides:
toXMLProcessor in class BioDataValuesImpl
Parameters:
doc - the working document
fillOutValues - a list of attribute names that should have full XML for their values.
Returns:
org.w3c.dom.Element an XML representation

getXMLMethodDescriptors

public java.util.Hashtable getXMLMethodDescriptors()
Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.

Overrides:
getXMLMethodDescriptors in class BioDataValuesImpl
Returns:
Hashtable The Hashtable of descriptors.

toString

public java.lang.String toString()
Returns a String representation of this object suitable for console display.

Overrides:
toString in class BioDataValuesImpl
Returns:
the String representation.

getSourceType

public java.lang.String getSourceType()

setSourceType

public void setSourceType(java.lang.String sourceType)