• Views
  • Iteration Report
  • My Iteration Report
  •  
OMERO.server
  • Login
  • Help/Guide
  • About Trac
  • Preferences
  • Wiki
  • Timeline
  • Roadmap
  • Browse Source
  • View Tickets
  • Search

Context Navigation

  • ← Previous Change
  • Next Change →

Changeset 104 for branches/omero

Show
Ignore:
Timestamp:
06/09/05 20:03:20 (4 years ago)
Author:
jmoore
Message:

Documentation / Javadoc update. Also added some logging.

Location:
branches/omero/components
Files:
29 modified

  • client/src/org/openmicroscopy/omero/client/ServiceFactory.java (modified) (1 diff)
  • client/src/org/openmicroscopy/omero/client/SpringHarness.java (modified) (2 diffs)
  • client/src/org/openmicroscopy/omero/client/spring.xml (modified) (1 diff)
  • client/test/org/openmicroscopy/omero/client/itests/OmeroHierarchyBrowsingIntegrationTest.java (modified) (4 diffs)
  • client/test/org/openmicroscopy/omero/client/itests/test.xml (modified) (1 diff)
  • common/.classpath (modified) (1 diff)
  • common/project.xml (modified) (1 diff)
  • common/src/org/openmicroscopy/omero/interfaces/HierarchyBrowsing.java (modified) (9 diffs)
  • common/src/org/openmicroscopy/omero/model2/Category2.java (modified) (1 diff)
  • common/src/org/openmicroscopy/omero/model2/CategoryGroup2.java (modified) (1 diff)
  • common/src/org/openmicroscopy/omero/tests/AbstractOmeroHierarchyBrowserIntegrationTest.java (modified) (2 diffs)
  • common/src/org/openmicroscopy/omero/tests/OMEData.java (modified) (2 diffs)
  • common/src/org/openmicroscopy/omero/tests/OMEPerformanceData.java (modified) (1 diff)
  • common/src/org/openmicroscopy/omero/util/Utils.java (modified) (3 diffs)
  • server/src/org/openmicroscopy/omero/logic/AnnotationDao.java (modified) (1 diff)
  • server/src/org/openmicroscopy/omero/logic/AnnotationDaoHibernate.java (modified) (2 diffs)
  • server/src/org/openmicroscopy/omero/logic/ContainerDao.java (modified) (1 diff)
  • server/src/org/openmicroscopy/omero/logic/ContainerDaoHibernate.java (modified) (2 diffs)
  • server/test/org/openmicroscopy/omero/server/itests/OmeroServiceTest.java (modified) (2 diffs)
  • server/test/org/openmicroscopy/omero/server/itests/OmeroThumbnailsBugTest.java (modified) (2 diffs)
  • server/test/org/openmicroscopy/omero/server/utests/HierarchyBrowsingUnitTest.java (modified) (3 diffs)
  • server/web/WEB-INF/config-test.xml (modified) (1 diff)
  • server/web/WEB-INF/config.xml (modified) (1 diff)
  • shoola-adapter/src/org/openmicroscopy/omero/shoolaadapter/AdapterUtils.java (modified) (3 diffs)
  • shoola-adapter/src/org/openmicroscopy/omero/shoolaadapter/HierarchyBrowsingAdapter.java (modified) (2 diffs)
  • shoola-adapter/src/org/openmicroscopy/omero/shoolaadapter/ServiceFactory.java (modified) (1 diff)
  • test/src/org/openmicroscopy/omero/test/OmeroGrinderTest.java (modified) (2 diffs)
  • test/src/org/openmicroscopy/shoola/env/data/t/ShoolaGrinderTest.java (modified) (1 diff)
  • test/src/speed.py (modified) (2 diffs)

Legend:

Unmodified
Added
Removed
  • branches/omero/components/client/src/org/openmicroscopy/omero/client/ServiceFactory.java

    r79 r104  
    11/* 
    2  * Created on May 8, 2005 
    3 */ 
     2 * org.openmicroscopy.omero.ServiceFactory 
     3 * 
     4 *------------------------------------------------------------------------------ 
     5 * 
     6 *  Copyright (C) 2004 Open Microscopy Environment 
     7 *      Massachusetts Institute of Technology, 
     8 *      National Institutes of Health, 
     9 *      University of Dundee 
     10 * 
     11 * 
     12 * 
     13 *    This library is free software; you can redistribute it and/or 
     14 *    modify it under the terms of the GNU Lesser General Public 
     15 *    License as published by the Free Software Foundation; either 
     16 *    version 2.1 of the License, or (at your option) any later version. 
     17 * 
     18 *    This library is distributed in the hope that it will be useful, 
     19 *    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     20 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     21 *    Lesser General Public License for more details. 
     22 * 
     23 *    You should have received a copy of the GNU Lesser General Public 
     24 *    License along with this library; if not, write to the Free Software 
     25 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
     26 * 
     27 *------------------------------------------------------------------------------ 
     28 */ 
     29 
    430package org.openmicroscopy.omero.client; 
    531 
     32//Java imports 
     33 
     34//Third-party libraries 
     35 
     36//Application-internal dependencies 
    637import org.openmicroscopy.omero.interfaces.HierarchyBrowsing; 
    738 
    8 /** 
    9  * @author josh 
     39/**  
     40 * Entry point for all client calls. Provides methods to  
     41 * obtain proxies for all remote facades.  
     42 *  
     43 * @author  Josh Moore      
     44 *                              <a href="mailto:josh.moore@gmx.de">josh.moore@gmx.de</a> 
     45 * @version 1.0  
     46 * <small> 
     47 * (<b>Internal version:</b> $Rev$ $Date$) 
     48 * </small> 
     49 * @since 1.0 
    1050 */ 
    1151public class ServiceFactory { 
  • branches/omero/components/client/src/org/openmicroscopy/omero/client/SpringHarness.java

    r98 r104  
    11/* 
    2  * Created on Jul 21, 2004 
     2 * org.openmicroscopy.shoola.ServiceFactory 
     3 * 
     4 *------------------------------------------------------------------------------ 
     5 * 
     6 *  Copyright (C) 2004 Open Microscopy Environment 
     7 *      Massachusetts Institute of Technology, 
     8 *      National Institutes of Health, 
     9 *      University of Dundee 
     10 * 
     11 * 
     12 * 
     13 *    This library is free software; you can redistribute it and/or 
     14 *    modify it under the terms of the GNU Lesser General Public 
     15 *    License as published by the Free Software Foundation; either 
     16 *    version 2.1 of the License, or (at your option) any later version. 
     17 * 
     18 *    This library is distributed in the hope that it will be useful, 
     19 *    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     20 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     21 *    Lesser General Public License for more details. 
     22 * 
     23 *    You should have received a copy of the GNU Lesser General Public 
     24 *    License along with this library; if not, write to the Free Software 
     25 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
     26 * 
     27 *------------------------------------------------------------------------------ 
    328 */ 
     29 
    430package org.openmicroscopy.omero.client; 
    531 
     32//Java imports 
    633import java.net.URL; 
    734 
     35//Third-party libraries 
    836import org.springframework.context.ApplicationContext; 
    937import org.springframework.context.support.FileSystemXmlApplicationContext; 
    1038 
    11 /** provides all objects needed for working with the meta package  
    12  * within the Spring Framework. 
    13  * @author moore 
     39//Application-internal dependencies 
     40 
     41 
     42 
     43/** provides context for all objects configured by the Spring Framework. 
     44 *  
     45 * @author  Josh Moore &nbsp;&nbsp;&nbsp;&nbsp; 
     46 *                              <a href="mailto:josh.moore@gmx.de">josh.moore@gmx.de</a> 
     47 * @version 1.0  
     48 * @DEV.TODO Possibly deprecate SpringHarness, make internal to ServiceFactory. 
     49 * <small> 
     50 * (<b>Internal version:</b> $Rev$ $Date$) 
     51 * </small> 
     52 * @since 1.0 
    1453 */ 
    1554public class SpringHarness { 
    … …  
    2261        path = SpringHarness.class.getClassLoader().getResource(springConfFile); 
    2362        if (path==null){ 
    24             throw new RuntimeException("Can't find spring.xml on classpath"); 
     63            throw new RuntimeException("Client jar corrupted. Can't find internal configuration file:\n"+springConfFile); 
    2564        } 
    2665        ctx = new FileSystemXmlApplicationContext(path.toString()); 
  • branches/omero/components/client/src/org/openmicroscopy/omero/client/spring.xml

    r98 r104  
    11<?xml version="1.0" encoding="UTF-8"?> 
     2<!-- 
     3#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     4# 
     5# Copyright (C) 2003 Open Microscopy Environment 
     6#       Massachusetts Institue of Technology, 
     7#       National Institutes of Health, 
     8#       University of Dundee 
     9# 
     10# 
     11# 
     12#    This library is free software; you can redistribute it and/or 
     13#    modify it under the terms of the GNU Lesser General Public 
     14#    License as published by the Free Software Foundation; either 
     15#    version 2.1 of the License, or (at your option) any later version. 
     16# 
     17#    This library is distributed in the hope that it will be useful, 
     18#    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     19#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     20#    Lesser General Public License for more details. 
     21# 
     22#    You should have received a copy of the GNU Lesser General Public 
     23#    License along with this library; if not, write to the Free Software 
     24#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
     25# 
     26#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     27--> 
     28 
     29<!-- 
     30#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     31# Written by:  Josh Moore <josh.moore@gmx.de> 
     32#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     33--> 
     34 
     35<!-- 
     36 
     37        Configuration of client proxies. 
     38  
     39--> 
     40 
    241<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> 
    342 
    4 <beans>  
     43        <beans>  
    544        <!-- ***** CONFIG ***** --> 
    645        <!-- property placeholder post-processor --> 
  • branches/omero/components/client/test/org/openmicroscopy/omero/client/itests/OmeroHierarchyBrowsingIntegrationTest.java

    r102 r104  
    11/* 
    2  * Created on Jun 7, 2005 
    3 */ 
     2 * org.openmicroscopy.omero.client.itests.OmeroHierarchyBrowsingIntegrationTest 
     3 * 
     4 *------------------------------------------------------------------------------ 
     5 * 
     6 *  Copyright (C) 2004 Open Microscopy Environment 
     7 *      Massachusetts Institute of Technology, 
     8 *      National Institutes of Health, 
     9 *      University of Dundee 
     10 * 
     11 * 
     12 * 
     13 *    This library is free software; you can redistribute it and/or 
     14 *    modify it under the terms of the GNU Lesser General Public 
     15 *    License as published by the Free Software Foundation; either 
     16 *    version 2.1 of the License, or (at your option) any later version. 
     17 * 
     18 *    This library is distributed in the hope that it will be useful, 
     19 *    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     20 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     21 *    Lesser General Public License for more details. 
     22 * 
     23 *    You should have received a copy of the GNU Lesser General Public 
     24 *    License along with this library; if not, write to the Free Software 
     25 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
     26 * 
     27 *------------------------------------------------------------------------------ 
     28 */ 
     29 
    430package org.openmicroscopy.omero.client.itests; 
    531 
     32//Java imports 
    633import java.util.HashSet; 
    734import java.util.Iterator; 
    835import java.util.Set; 
    936 
     37import org.apache.commons.logging.Log; 
     38import org.apache.commons.logging.LogFactory; 
     39 
     40//Third-party libraries 
     41 
     42//Application-internal dependencies 
    1043import org.openmicroscopy.omero.model.Category; 
    1144import org.openmicroscopy.omero.model.CategoryGroup; 
    … …  
    1750import org.openmicroscopy.omero.tests.OMEPerformanceData; 
    1851 
    19 /** 
    20  * @author josh 
     52/** Tests calls through to the database, using all necessary layers. Specifics  
     53 * are available in abstract super class. 
     54 *  
     55 * @author  Josh Moore &nbsp;&nbsp;&nbsp;&nbsp; 
     56 *                              <a href="mailto:josh.moore@gmx.de">josh.moore@gmx.de</a> 
     57 * @version 1.0  
     58 * <small> 
     59 * (<b>Internal version:</b> $Rev$ $Date$) 
     60 * </small> 
     61 * @since 1.0 
     62 * @see org.openmicroscopy.omero.tests.AbstractOmeroHierarchyBrowserIntegrationTest 
    2163 */ 
    2264public class OmeroHierarchyBrowsingIntegrationTest 
    … …  
    2870     */ 
    2971    protected String[] getConfigLocations() { 
    30         return new String[]{"org/openmicroscopy/omero/client/spring.xml"};  
     72        return new String[]{"org/openmicroscopy/omero/client/spring.xml", 
     73                "org/openmicroscopy/omero/client/itests/test.xml"};  
    3174    } 
    3275     
    … …  
    3881        super("Omero Integration Test with Data",data); 
    3982    } 
    40      
    41     public void testContainerCallWithWrongParameters(){ 
    42         try { 
    43             getHb().loadPDIHierarchy(Object.class,1); 
    44             fail("loadPDIHierarchy(class,int) didn't choke on bad class."); 
    45         } catch (IllegalArgumentException iae){ 
    46             // We should get here. TODO log 
    47         } 
    48  
    49         try { 
    50             getHb().loadCGCIHierarchy(Object.class,1); 
    51             fail("loadCGCIHierarchy(class,int) didn't choke on bad class."); 
    52         } catch (IllegalArgumentException iae){ 
    53             // We should get here. TODO log 
    54         } 
    55               
    56        } 
    57      
    58     String nullObj = "This should get us nothing."; 
    59     String emptyColl = "This collection should be empty."; 
    60     String nonNull = "We should get something back"; 
    61  
    62     public void testNulls(){ 
    63         // Each method should return a null or an empty set as appropriate 
    64         //TODO getHb().findCGCIHierarchies(     ); 
    65         //TODO generate OMENullData(); and use it here. 
    66         //TODO OMEData toString(); 
    67          
    68         Set test = new HashSet(); 
    69         test.add(new Integer(0)); // Non-existence set of ids 
    70         int nonExp = 0; // Non-existence experimenter ID 
    71         // 
    72         assertTrue(emptyColl,getHb().findDatasetAnnotations(test).size()==0); 
    73         assertTrue(emptyColl,getHb().findDatasetAnnotations(new HashSet()).size()==0); 
    74         // 
    75         assertTrue(emptyColl,getHb().findDatasetAnnotationsForExperimenter(test,nonExp).size()==0); 
    76         assertTrue(emptyColl,getHb().findDatasetAnnotationsForExperimenter(new HashSet(),nonExp).size()==0); 
    77         // 
    78         assertTrue(emptyColl,getHb().findImageAnnotations(test).size()==0); 
    79         assertTrue(emptyColl,getHb().findImageAnnotations(new HashSet()).size()==0); 
    80         // 
    81         assertTrue(emptyColl,getHb().findImageAnnotationsForExperimenter(test,nonExp).size()==0); 
    82         assertTrue(emptyColl,getHb().findImageAnnotationsForExperimenter(new HashSet(),nonExp).size()==0); 
    83         // 
    84         assertTrue(emptyColl,getHb().findPDIHierarchies(test).size()==0); 
    85         assertTrue(emptyColl,getHb().findPDIHierarchies(new HashSet()).size()==0); 
    86         // 
    87         assertNull(nullObj,getHb().loadCGCIHierarchy(CategoryGroup.class, 0)); 
    88         assertNull(nullObj,getHb().loadCGCIHierarchy(Category.class, 0)); 
    89         // 
    90         assertNull(nullObj,getHb().loadPDIHierarchy(Project.class, 0)); 
    91         assertNull(nullObj,getHb().loadPDIHierarchy(Dataset.class, 0)); 
    92     } 
    93      
    94     public void testContainedImages(){ 
    95         // Something 
    96         Set result = (Set) testFindPDIHierarchies(); 
    97         assertTrue(nonNull, result != null && result.size() != 0); 
    98         // Not to much 
    99         Set test = new HashSet(); 
    100         Iterator i = result.iterator(); 
    101         while (i.hasNext()){ 
    102             Object o = i.next(); 
    103             if (o instanceof Image) { 
    104                 test.add(o); 
    105             } else if (o instanceof Dataset) { 
    106                 Dataset dd = (Dataset) o; 
    107                 test.addAll(dd.getImages()); 
    108             } else if (o instanceof Project) { 
    109                 Project pd = (Project) o; 
    110                 Iterator p = pd.getDatasets().iterator(); 
    111                 while (p.hasNext()){ 
    112                     Dataset dd = (Dataset) p.next(); 
    113                     test.addAll(dd.getImages()); 
    114                 } 
    115             } 
    116         } 
    117         assertTrue("There should only be as many images as in the data.imagesPDI", test.size() == this.getData().imgsPDI.size()); 
    118 //      TODO Make sure joins aren't leaving anything out because of empties! 
    119     } 
    120  
    12183    
    12284} 
  • branches/omero/components/client/test/org/openmicroscopy/omero/client/itests/test.xml

    r102 r104  
    11<?xml version="1.0" encoding="UTF-8"?> 
     2<!-- 
     3#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     4# 
     5# Copyright (C) 2003 Open Microscopy Environment 
     6#       Massachusetts Institue of Technology, 
     7#       National Institutes of Health, 
     8#       University of Dundee 
     9# 
     10# 
     11# 
     12#    This library is free software; you can redistribute it and/or 
     13#    modify it under the terms of the GNU Lesser General Public 
     14#    License as published by the Free Software Foundation; either 
     15#    version 2.1 of the License, or (at your option) any later version. 
     16# 
     17#    This library is distributed in the hope that it will be useful, 
     18#    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     19#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     20#    Lesser General Public License for more details. 
     21# 
     22#    You should have received a copy of the GNU Lesser General Public 
     23#    License along with this library; if not, write to the Free Software 
     24#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
     25# 
     26#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     27--> 
     28 
     29<!-- 
     30#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     31# Written by:  Josh Moore <josh.moore@gmx.de> 
     32#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     33--> 
     34 
     35<!-- 
     36 
     37        Test configuration for the client side. The dataSource is necessary 
     38        so that data can query for existing values. 
     39  
     40--> 
    241<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> 
    342 
  • branches/omero/components/common/.classpath

    r100 r104  
    1616  <classpathentry kind="var" path="MAVEN_REPO/commons-lang/jars/commons-lang-2.0.jar"> 
    1717  </classpathentry> 
     18  <classpathentry kind="var" path="MAVEN_REPO/commons-logging/jars/commons-logging-1.0.4.jar"> 
     19  </classpathentry> 
    1820  <classpathentry kind="var" path="MAVEN_REPO/postgresql/jars/postgresql-7.4.1-jdbc3.jar"> 
    1921  </classpathentry> 
  • branches/omero/components/common/project.xml

    r100 r104  
    3636    </dependency> 
    3737    <dependency> 
     38      <groupId>commons-logging</groupId> 
     39      <artifactId>commons-logging</artifactId> 
     40      <version>1.0.4</version> 
     41    </dependency> 
     42    <dependency> 
    3843      <groupId>postgresql</groupId> 
    3944      <artifactId>postgresql</artifactId> 
  • branches/omero/components/common/src/org/openmicroscopy/omero/interfaces/HierarchyBrowsing.java

    r95 r104  
    5757 * </small> 
    5858 * @since OME2.2 
     59 * @DEV.TODO Possibly change these methods to return an abstract super type  
     60 * @DEV.TODO or even a concretefor these or concrete type like "Project loadPDIHierary()" 
     61 * @DEV.TODO Update code generation for Hibernate to include copyright.  
    5962 */ 
    6063public interface HierarchyBrowsing 
    … …  
    6467     * Loads a Project/Dataset/Image (P/D/I) hierarchy rooted by a given node. 
    6568     * <p>The root node can be either Project or Dataset.  A Project tree will 
    66      * be represented by {@link ProjectData}, {@link DatasetData}, and 
    67      * {@link ImageData} objects.  A Dataset tree will only have objects of 
     69     * be represented by {@link Project}, {@link Dataset}, and 
     70     * {@link Image} objects.  A Dataset tree will only have objects of 
    6871     * the latter two types.</p> 
    6972     * <p>This method also retrieves the Experimenters linked to the objects 
    7073     * in the tree &#151; an Experimenter is represented by an  
    71      * {@link ExperimenterData} object.  Similarly, all Images will be linked 
    72      * to their Pixels &#151; represented by {@link PixelsData} objects.</p> 
     74     * {@link Experimenter} object.  Similarly, all Images will be linked 
     75     * to their Pixels &#151; represented by {@link Pixels} objects.</p> 
    7376     * <p>Note that objects are never duplicated.  For example, if an  
    7477     * Experimenter owns all the objects in the retrieved tree, then those 
    7578     * objects will be linked to the <i>same</i> instance of 
    76      * {@link ExperimenterData}.  Or if an Image is contained in more than 
    77      * one Dataset in the retrieved tree, then all enclosing {@link DatasetData} 
    78      * objects will point to the <i>same</i> {@link ImageData} object.  And so 
     79     * {@link Experimenter}.  Or if an Image is contained in more than 
     80     * one Dataset in the retrieved tree, then all enclosing {@link Dataset} 
     81     * objects will point to the <i>same</i> {@link Image} object.  And so 
    7982     * on.</p> 
    8083     *  
    8184     * @param rootNodeType  The type of the root node.  Can either be 
    82      *                      {@link ProjectData} or {@link DatasetData}. 
     85     *                      {@link Project} or {@link Dataset}. 
    8386     * @param rootNodeID    The id of the root node. 
    8487     * @return The requested node as root and all of its descendants.  The type 
    … …  
    8689     */ 
    8790    public Object loadPDIHierarchy(Class rootNodeType, int rootNodeID);  
    88     // TODO Super Object for these or concrete "Project loadPDIHierary() / Dataset loadDIHierarchy()"???  
    8991     
    9092    /** 
    … …  
    9294     * given node. 
    9395     * <p>The root node can be either Category Group or Category.  A Category 
    94      * Group tree will be represented by {@link CategoryGroupData},  
    95      * {@link CategoryData}, and {@link ImageData} objects.  A Category tree 
     96     * Group tree will be represented by {@link CategoryGroup},  
     97     * {@link Category}, and {@link Image} objects.  A Category tree 
    9698     * will only have objects of the latter two types.</p> 
    9799     * <p>This method also retrieves the Experimenters linked to the objects 
    98100     * in the tree &#151; an Experimenter is represented by an  
    99      * {@link ExperimenterData} object.  Similarly, all Images will be linked 
    100      * to their Pixels &#151; represented by {@link PixelsData} objects.</p> 
     101     * {@link Experimenter} object.  Similarly, all Images will be linked 
     102     * to their Pixels &#151; represented by {@link Pixels} objects.</p> 
    101103     * <p>Note that objects are never duplicated.  For example, if an  
    102104     * Experimenter owns all the objects in the retrieved tree, then those 
    103105     * objects will be linked to the <i>same</i> instance of 
    104      * {@link ExperimenterData}.</p> 
     106     * {@link Experimenter}.</p> 
    105107     *  
    106108     * @param rootNodeType  The type of the root node.  Can either be 
    107      *                      {@link CategoryGroupData} or {@link CategoryData}. 
     109     *                      {@link CategoryGroup} or {@link Category}. 
    108110     * @param rootNodeID    The id of the root node. 
    109111     * @return The requested node as root and all of its descendants.  The type 
    … …  
    117119     * <p>This method will look for all the Datasets containing the specified  
    118120     * Images and then for all Projects containing those Datasets.  In the  
    119      * returned trees, Projects will be represented by {@link ProjectData} 
    120      * objects, Datasets by {@link DatasetData} objects, and Images by 
    121      * {@link ImageData} objects.</p> 
     121     * returned trees, Projects will be represented by {@link Project} 
     122     * objects, Datasets by {@link Dataset} objects, and Images by 
     123     * {@link Image} objects.</p> 
    122124     * <p>This method returns a <code>Set</code> with all root nodes that were 
    123125     * found.  Every root node is linked to the found objects and so on until 
    124      * the leaf nodes, which are {@link ImageData} objects.  Note that the type 
    125      * of any root node in the returned set can be {@link ProjectData},  
    126      * {@link DatasetData}, or {@link ImageData}.</p> 
     126     * the leaf nodes, which are {@link Image} objects.  Note that the type 
     127     * of any root node in the returned set can be {@link Project},  
     128     * {@link Dataset}, or {@link Image}.</p> 
    127129     * <p>For example, say that you pass in the ids of six Images: <code>i1, i2, 
    128130     * i3, i4, i5, i6</code>.  If the P/D/I hierarchy in the DB looks like this: 
    … …  
    175177     * Image.  If no annotations were found for that Image, then the entry 
    176178     * will be <code>null</code>.  Otherwise it will be a <code>Set</code> 
    177      * containing {@link AnnotationData} objects. 
     179     * containing {@link Annotation} objects. 
    178180     *  
    179181     * @param imgIDs Contains the ids of the Images. 
    … …  
    192194     * Image.  If no annotations were found for that Image, then the entry 
    193195     * will be <code>null</code>.  Otherwise it will be a <code>Set</code> 
    194      * containing {@link AnnotationData} objects. 
     196     * containing {@link Annotation} objects. 
    195197     *  
    196198     * @param imgIDs Contains the ids of the Images. 
    … …  
    210212     * Dataset.  If no annotations were found for that Dataset, then the 
    211213     * entry will be <code>null</code>.  Otherwise it will be a <code>Set 
    212      * </code> containing {@link AnnotationData} objects. 
     214     * </code> containing {@link Annotation} objects. 
    213215     *  
    214216     * @param datasetIDs Contains the ids of the Datasets. 
    … …  
    227229     * Dataset.  If no annotations were found for that Image, then the entry 
    228230     * will be <code>null</code>.  Otherwise it will be a <code>Set</code> 
    229      * containing {@link AnnotationData} objects. 
     231     * containing {@link Annotation} objects. 
    230232     *  
    231233     * @param datasetIDs Contains the ids of the Datasets. 
  • branches/omero/components/common/src/org/openmicroscopy/omero/model2/Category2.java

    r83 r104  
    11/* 
    2  * Created on May 31, 2005 
    3 */ 
     2 * org.openmicroscopy.omero.model2 
     3 * 
     4 *------------------------------------------------------------------------------ 
     5 * 
     6 *  Copyright (C) 2004 Open Microscopy Environment 
     7 *      Massachusetts Institute of Technology, 
     8 *      National Institutes of Health, 
     9 *      University of Dundee 
     10 * 
     11 * 
     12 * 
     13 *    This library is free software; you can redistribute it and/or 
     14 *    modify it under the terms of the GNU Lesser General Public 
     15 *    License as published by the Free Software Foundation; either 
     16 *    version 2.1 of the License, or (at your option) any later version. 
     17 * 
     18 *    This library is distributed in the hope that it will be useful, 
     19 *    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     20 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     21 *    Lesser General Public License for more details. 
     22 * 
     23 *    You should have received a copy of the GNU Lesser General Public 
     24 *    License along with th