src/core/net/sf/basedb/util/listable/ToRawBioAssaySourceItemTransformerFactory.java

Code
Comments
Other
Rev Date Author Line
6777 17 Mar 15 nicklas 1 /**
6777 17 Mar 15 nicklas 2   $Id$
6777 17 Mar 15 nicklas 3
6777 17 Mar 15 nicklas 4   Copyright (C) 2015 Nicklas Nordborg
6777 17 Mar 15 nicklas 5
6777 17 Mar 15 nicklas 6   This file is part of BASE - BioArray Software Environment.
6777 17 Mar 15 nicklas 7   Available at http://base.thep.lu.se/
6777 17 Mar 15 nicklas 8
6777 17 Mar 15 nicklas 9   BASE is free software; you can redistribute it and/or
6777 17 Mar 15 nicklas 10   modify it under the terms of the GNU General Public License
6777 17 Mar 15 nicklas 11   as published by the Free Software Foundation; either version 3
6777 17 Mar 15 nicklas 12   of the License, or (at your option) any later version.
6777 17 Mar 15 nicklas 13
6777 17 Mar 15 nicklas 14   BASE is distributed in the hope that it will be useful,
6777 17 Mar 15 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
6777 17 Mar 15 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
6777 17 Mar 15 nicklas 17   GNU General Public License for more details.
6777 17 Mar 15 nicklas 18
6777 17 Mar 15 nicklas 19   You should have received a copy of the GNU General Public License
6777 17 Mar 15 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
6777 17 Mar 15 nicklas 21 */
6777 17 Mar 15 nicklas 22 package net.sf.basedb.util.listable;
6777 17 Mar 15 nicklas 23
6777 17 Mar 15 nicklas 24 import java.util.ArrayList;
6777 17 Mar 15 nicklas 25 import java.util.List;
6777 17 Mar 15 nicklas 26
6777 17 Mar 15 nicklas 27 import net.sf.basedb.core.Item;
6777 17 Mar 15 nicklas 28 import net.sf.basedb.core.SyncFilter.SourceItemTransform;
6777 17 Mar 15 nicklas 29
6777 17 Mar 15 nicklas 30 /**
6777 17 Mar 15 nicklas 31   Transformer factory implementation for transforming to raw bioassays.
6777 17 Mar 15 nicklas 32   The current implementation support transforming from:
6777 17 Mar 15 nicklas 33   
6777 17 Mar 15 nicklas 34   <ul>
6777 17 Mar 15 nicklas 35   <li>{@link SourceItemTransform#PARENT_TO_CHILD}: BIOSOURCE, SAMPLE, EXTRACT, PHYSICALBIOASSAY, DERIVEDBIOASSAY
6777 17 Mar 15 nicklas 36   <li>{@link SourceItemTransform#CHILD_TO_PARENT}: None
6777 17 Mar 15 nicklas 37   </ul>
6777 17 Mar 15 nicklas 38
6777 17 Mar 15 nicklas 39   @author Nicklas
6777 17 Mar 15 nicklas 40   @since 3.5
6777 17 Mar 15 nicklas 41 */
6777 17 Mar 15 nicklas 42 public class ToRawBioAssaySourceItemTransformerFactory 
6777 17 Mar 15 nicklas 43   extends AbstractSourceItemTransformerFactory
6777 17 Mar 15 nicklas 44 {
6777 17 Mar 15 nicklas 45
6777 17 Mar 15 nicklas 46   private static Item[] PARENT_TO_CHILD = 
6777 17 Mar 15 nicklas 47     { Item.BIOSOURCE, Item.SAMPLE, Item.EXTRACT, Item.PHYSICALBIOASSAY, Item.DERIVEDBIOASSAY };
6777 17 Mar 15 nicklas 48   
6777 17 Mar 15 nicklas 49   private static Item[] CHILD_TO_PARENT = {};
6777 17 Mar 15 nicklas 50   
6777 17 Mar 15 nicklas 51   
6777 17 Mar 15 nicklas 52   public ToRawBioAssaySourceItemTransformerFactory() 
6777 17 Mar 15 nicklas 53   {
6777 17 Mar 15 nicklas 54     super(Item.RAWBIOASSAY, PARENT_TO_CHILD, CHILD_TO_PARENT);
6777 17 Mar 15 nicklas 55   }
6777 17 Mar 15 nicklas 56     
6777 17 Mar 15 nicklas 57   @Override
6790 20 Mar 15 nicklas 58   public SourceItemTransformer create(final Item sourceItemType, final SourceItemTransform transform) 
6777 17 Mar 15 nicklas 59   {
6777 17 Mar 15 nicklas 60     List<SourceItemTransformer> chain = new ArrayList<SourceItemTransformer>();
6792 23 Mar 15 nicklas 61     Item stepBySource = null;
6792 23 Mar 15 nicklas 62     CollectExtracts collectedExtracts = null;
6777 17 Mar 15 nicklas 63     
6792 23 Mar 15 nicklas 64     if (transform == SourceItemTransform.PARENT_TO_CHILD)
6792 23 Mar 15 nicklas 65     {
6792 23 Mar 15 nicklas 66       // Transforming a list of parent items to child raw bioassays
6792 23 Mar 15 nicklas 67       // We do step-wise loading from BIOSOURCE -> SAMPLE -> EXTRACT -> PHYSICALBIOASSAY -> DERIVEDBIOASSAY -> RAWBIOASSAY
6792 23 Mar 15 nicklas 68       if (sourceItemType == Item.BIOSOURCE)
6792 23 Mar 15 nicklas 69       {
6792 23 Mar 15 nicklas 70         // Load child samples of the biosources
6792 23 Mar 15 nicklas 71         chain.add(new BioSourceToSampleTransformer());
6792 23 Mar 15 nicklas 72         stepBySource = Item.SAMPLE;
6792 23 Mar 15 nicklas 73       }
6792 23 Mar 15 nicklas 74       if (sourceItemType == Item.SAMPLE || stepBySource == Item.SAMPLE)
6792 23 Mar 15 nicklas 75       {
7772 17 Feb 20 nicklas 76         // Expand source selection to parents if the children push annotations upwards
7772 17 Feb 20 nicklas 77         if (sourceItemType == Item.SAMPLE) chain.add(new PushToParentsTransformer(sourceItemType));
6792 23 Mar 15 nicklas 78         // Load child samples including the original samples
6792 23 Mar 15 nicklas 79         chain.add(new SampleToChildSampleTransformer(true));
6792 23 Mar 15 nicklas 80         // Transform to child extracts
6792 23 Mar 15 nicklas 81         chain.add(new SampleToExtractTransformer());
6792 23 Mar 15 nicklas 82         stepBySource = Item.EXTRACT;
6792 23 Mar 15 nicklas 83       }
6792 23 Mar 15 nicklas 84       if (sourceItemType == Item.EXTRACT || stepBySource == Item.EXTRACT)
6792 23 Mar 15 nicklas 85       {
6801 25 Mar 15 nicklas 86         // Save collected extracts
6801 25 Mar 15 nicklas 87         collectedExtracts = new CollectExtracts();
6801 25 Mar 15 nicklas 88         if (sourceItemType == Item.EXTRACT)
6801 25 Mar 15 nicklas 89         {
6801 25 Mar 15 nicklas 90           // Collect parent extracts since those are also valid when joining child derived bioassays
6801 25 Mar 15 nicklas 91           chain.add(collectedExtracts.collectParentsOfSource(false));
7772 17 Feb 20 nicklas 92           // Expand source selection to parents if the children push annotations upwards
7772 17 Feb 20 nicklas 93           chain.add(new PushToParentsTransformer(sourceItemType));
6801 25 Mar 15 nicklas 94         }
6801 25 Mar 15 nicklas 95         
6792 23 Mar 15 nicklas 96         // Load child extract and include the source extracts
6792 23 Mar 15 nicklas 97         chain.add(new ExtractToChildExtractTransformer(true));
6801 25 Mar 15 nicklas 98         // Collect extracts that we pass while going down
6801 25 Mar 15 nicklas 99         chain.add(collectedExtracts.collectFromExtracts());
6792 23 Mar 15 nicklas 100         // Load all related physical bioassays
6792 23 Mar 15 nicklas 101         chain.add(new ExtractToPhysicalBioAssayTransformer());
6792 23 Mar 15 nicklas 102         stepBySource = Item.PHYSICALBIOASSAY;
6792 23 Mar 15 nicklas 103       }
6792 23 Mar 15 nicklas 104       if (sourceItemType == Item.PHYSICALBIOASSAY || stepBySource == Item.PHYSICALBIOASSAY)
6792 23 Mar 15 nicklas 105       {
6792 23 Mar 15 nicklas 106         // Load child derived bioassays
6801 25 Mar 15 nicklas 107         // We stop here because the transformer always load all children, grandchildren, etc.
6792 23 Mar 15 nicklas 108         chain.add(new PhysicalBioAssayToDerivedBioAssayTransformer(collectedExtracts));
6801 25 Mar 15 nicklas 109         if (collectedExtracts != null)
6801 25 Mar 15 nicklas 110         {
6801 25 Mar 15 nicklas 111           // Merge derived bioassays that has direct links to collected extracts
6801 25 Mar 15 nicklas 112           chain.add(new CollectedExtractsToDerivedBioAssayTransformer(collectedExtracts));
6801 25 Mar 15 nicklas 113         }
6801 25 Mar 15 nicklas 114         
6792 23 Mar 15 nicklas 115         // Load child raw bioassays
6801 25 Mar 15 nicklas 116         chain.add(new DerivedBioAssayToRawBioAssayTransformer());
6801 25 Mar 15 nicklas 117         if (collectedExtracts != null)
6801 25 Mar 15 nicklas 118         {
6801 25 Mar 15 nicklas 119           // Merge raw bioassays that has direct links to collected extracts
6801 25 Mar 15 nicklas 120           chain.add(new CollectedExtractsToRawBioAssayTransformer(collectedExtracts));
6801 25 Mar 15 nicklas 121         }
6801 25 Mar 15 nicklas 122         
6792 23 Mar 15 nicklas 123       }
6792 23 Mar 15 nicklas 124       if (sourceItemType == Item.DERIVEDBIOASSAY)
6792 23 Mar 15 nicklas 125       {
6792 23 Mar 15 nicklas 126         // Load child derived bioassays
6792 23 Mar 15 nicklas 127         chain.add(new DerivedBioAssayToChildDerivedBioAssayTransformer(true));
6792 23 Mar 15 nicklas 128         // Load child raw bioassays
6792 23 Mar 15 nicklas 129         chain.add(new DerivedBioAssayToRawBioAssayTransformer());
6792 23 Mar 15 nicklas 130       }
6792 23 Mar 15 nicklas 131     }
6777 17 Mar 15 nicklas 132     
6777 17 Mar 15 nicklas 133     return chain.size() == 0 ? null : new SourceItemTransformerChain(chain);
6777 17 Mar 15 nicklas 134   }
6777 17 Mar 15 nicklas 135
6777 17 Mar 15 nicklas 136 }