affyfusion-109/src/affymetrix/calvin/array/ArrayData.java

Code
Comments
Other
Rev Date Author Line
11 13 Sep 07 nicklas 1 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 2 //
11 13 Sep 07 nicklas 3 // Copyright (C) 2005 Affymetrix, Inc.
11 13 Sep 07 nicklas 4 //
11 13 Sep 07 nicklas 5 // This library is free software; you can redistribute it and/or modify
11 13 Sep 07 nicklas 6 // it under the terms of the GNU Lesser General Public License as published
11 13 Sep 07 nicklas 7 // by the Free Software Foundation; either version 2.1 of the License,
11 13 Sep 07 nicklas 8 // or (at your option) any later version.
11 13 Sep 07 nicklas 9 //
11 13 Sep 07 nicklas 10 // This library is distributed in the hope that it will be useful, but
11 13 Sep 07 nicklas 11 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 13 Sep 07 nicklas 12 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
11 13 Sep 07 nicklas 13 // for more details.
11 13 Sep 07 nicklas 14 //
11 13 Sep 07 nicklas 15 // You should have received a copy of the GNU Lesser General Public License
11 13 Sep 07 nicklas 16 // along with this library; if not, write to the Free Software Foundation, Inc.,
11 13 Sep 07 nicklas 17 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
11 13 Sep 07 nicklas 18 //
11 13 Sep 07 nicklas 19 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 20
11 13 Sep 07 nicklas 21 package affymetrix.calvin.array;
11 13 Sep 07 nicklas 22
11 13 Sep 07 nicklas 23 import affymetrix.calvin.parameter.*;
11 13 Sep 07 nicklas 24 import affymetrix.calvin.utils.*;
11 13 Sep 07 nicklas 25 import java.util.*;
11 13 Sep 07 nicklas 26
11 13 Sep 07 nicklas 27 /** This class provides interfaces to store array information. */
11 13 Sep 07 nicklas 28 public class ArrayData {
11 13 Sep 07 nicklas 29     
11 13 Sep 07 nicklas 30     /** A unique idendifier for the array set object */
11 13 Sep 07 nicklas 31     private AffymetrixGuidType fileId;
11 13 Sep 07 nicklas 32
11 13 Sep 07 nicklas 33     /** An identifier to the type of data stored in the file */
11 13 Sep 07 nicklas 34     private AffymetrixGuidType dataTypeId;
11 13 Sep 07 nicklas 35
11 13 Sep 07 nicklas 36     /** The step in Calvin that created the array set data. */
11 13 Sep 07 nicklas 37     private int /*CreateStep*/ createdStep;
11 13 Sep 07 nicklas 38
11 13 Sep 07 nicklas 39     /** The name of the project that initially created the array set data. */
11 13 Sep 07 nicklas 40     private String initialProject;
11 13 Sep 07 nicklas 41
11 13 Sep 07 nicklas 42     /** The date and time of initial creation. */
11 13 Sep 07 nicklas 43     private String creationDateTime;
11 13 Sep 07 nicklas 44
11 13 Sep 07 nicklas 45     /** The user who created the data object. */
11 13 Sep 07 nicklas 46     private String createdBy;
11 13 Sep 07 nicklas 47
11 13 Sep 07 nicklas 48     /** The arrays attributes for the arrays in the set */
11 13 Sep 07 nicklas 49     private Vector /*ArrayAttributes*/ physicalArraysAttributes;
11 13 Sep 07 nicklas 50
11 13 Sep 07 nicklas 51     /** The user attributes */
11 13 Sep 07 nicklas 52     private Vector /*ParameterNameValueDefaultRequired*/ userAttributes;
11 13 Sep 07 nicklas 53
11 13 Sep 07 nicklas 54     /** The unique idendifier for the array set.
11 13 Sep 07 nicklas 55      * @return The unique idendifier for the array set.
11 13 Sep 07 nicklas 56      */
11 13 Sep 07 nicklas 57     public AffymetrixGuidType getArraySetFileIdentifier() { return fileId; }
11 13 Sep 07 nicklas 58
11 13 Sep 07 nicklas 59     /** The unique idendifier for the array set.
11 13 Sep 07 nicklas 60      * @param value The unique idendifier for the array set.
11 13 Sep 07 nicklas 61      */
11 13 Sep 07 nicklas 62     public void setArraySetFileIdentifier(AffymetrixGuidType value) { fileId=value; }
11 13 Sep 07 nicklas 63
11 13 Sep 07 nicklas 64     /** The identifier of the type of data stored in the file.
11 13 Sep 07 nicklas 65      * @return The identifier of the type of data.
11 13 Sep 07 nicklas 66      */
11 13 Sep 07 nicklas 67     public AffymetrixGuidType getDataTypeIdentifier() { return dataTypeId; }
11 13 Sep 07 nicklas 68
11 13 Sep 07 nicklas 69     /** The identifier of the type of data stored in the file.
11 13 Sep 07 nicklas 70      * @param value The identifier of the type of data.
11 13 Sep 07 nicklas 71      */
11 13 Sep 07 nicklas 72     public void setDataTypeIdentifier(AffymetrixGuidType value) { dataTypeId=value; }
11 13 Sep 07 nicklas 73
11 13 Sep 07 nicklas 74     /** The step in Calvin that created the array set data.
11 13 Sep 07 nicklas 75      * @return The step in calvin that create the array set data.
11 13 Sep 07 nicklas 76      */
11 13 Sep 07 nicklas 77     public int /*CreateStep*/ getCreatedStep() { return createdStep; }
11 13 Sep 07 nicklas 78
11 13 Sep 07 nicklas 79     /** The step in Calvin that created the array set data.
11 13 Sep 07 nicklas 80      * @param value The step in calvin that create the array set data.
11 13 Sep 07 nicklas 81      */
11 13 Sep 07 nicklas 82     public void setCreatedStep(int /*CreateStep*/ value) { createdStep=value; }
11 13 Sep 07 nicklas 83
11 13 Sep 07 nicklas 84     /** The name of the project that initially created the array set data.
11 13 Sep 07 nicklas 85      * @return The project name.
11 13 Sep 07 nicklas 86      */
11 13 Sep 07 nicklas 87     public String getInitialProject() { return initialProject; }
11 13 Sep 07 nicklas 88
11 13 Sep 07 nicklas 89     /** The name of the project that initially created the array set data.
11 13 Sep 07 nicklas 90      * @param value The project name.
11 13 Sep 07 nicklas 91      */
11 13 Sep 07 nicklas 92     public void setInitialProject(String value) { initialProject=value; }
11 13 Sep 07 nicklas 93
11 13 Sep 07 nicklas 94     /** The date and time of initial creation.
11 13 Sep 07 nicklas 95      * @return The creation date and time.
11 13 Sep 07 nicklas 96      */
11 13 Sep 07 nicklas 97     public String getCreationDateTime() { return creationDateTime; }
11 13 Sep 07 nicklas 98
11 13 Sep 07 nicklas 99     /** The date and time of initial creation.
11 13 Sep 07 nicklas 100      * @param value The creation date and time.
11 13 Sep 07 nicklas 101      */
11 13 Sep 07 nicklas 102     public void setCreationDateTime(String value) { creationDateTime=value; }
11 13 Sep 07 nicklas 103
11 13 Sep 07 nicklas 104     /** The user who created the data object.
11 13 Sep 07 nicklas 105      * @return The user name.
11 13 Sep 07 nicklas 106      */
11 13 Sep 07 nicklas 107     public String getCreatedBy() { return createdBy; }
11 13 Sep 07 nicklas 108
11 13 Sep 07 nicklas 109     /** The user who created the data object.
11 13 Sep 07 nicklas 110      * @param value The user name.
11 13 Sep 07 nicklas 111      */
11 13 Sep 07 nicklas 112     public void setCreatedBy(String value) { createdBy=value; }
11 13 Sep 07 nicklas 113
11 13 Sep 07 nicklas 114     /** The arrays attributes. Each array in a set will have its own attributes.
11 13 Sep 07 nicklas 115      * @return The vector of arrays attributes.
11 13 Sep 07 nicklas 116      */
11 13 Sep 07 nicklas 117     public Vector /*ArrayAttributes*/ getPhysicalArraysAttributes() { return physicalArraysAttributes; }
11 13 Sep 07 nicklas 118
11 13 Sep 07 nicklas 119     /** The arrays attributes. Each array in a set will have its own attributes.
11 13 Sep 07 nicklas 120      * @param value The vector of arrays attributes.
11 13 Sep 07 nicklas 121      */
11 13 Sep 07 nicklas 122     public void setPhysicalArraysAttributes(Vector /*ArrayAttributes*/ value) { physicalArraysAttributes=value; }
11 13 Sep 07 nicklas 123
11 13 Sep 07 nicklas 124     /** The user attributes.
11 13 Sep 07 nicklas 125      * @return The vector of user attributes.
11 13 Sep 07 nicklas 126      */
11 13 Sep 07 nicklas 127     public Vector /*ParameterNameValueDefaultRequired*/ getUserAttributes() { return userAttributes; }
11 13 Sep 07 nicklas 128
11 13 Sep 07 nicklas 129     /** The user attributes.
11 13 Sep 07 nicklas 130      * @param value The vector of user attributes.
11 13 Sep 07 nicklas 131      */
11 13 Sep 07 nicklas 132     public void setUserAttributes(Vector /*ParameterNameValueDefaultRequired*/ value) { userAttributes=value; }
11 13 Sep 07 nicklas 133
11 13 Sep 07 nicklas 134     /** Clears the member objects. */
11 13 Sep 07 nicklas 135     public void clear() {
11 13 Sep 07 nicklas 136         physicalArraysAttributes=null;
11 13 Sep 07 nicklas 137   userAttributes=null;
11 13 Sep 07 nicklas 138   fileId=null;
11 13 Sep 07 nicklas 139   dataTypeId=null;
11 13 Sep 07 nicklas 140   createdStep=CreateStep.NoStep;
11 13 Sep 07 nicklas 141   initialProject="";
11 13 Sep 07 nicklas 142   creationDateTime="";
11 13 Sep 07 nicklas 143   createdBy="";
11 13 Sep 07 nicklas 144     }
11 13 Sep 07 nicklas 145     
11 13 Sep 07 nicklas 146     /** Creates a new instance of ArrayData. */
11 13 Sep 07 nicklas 147     public ArrayData() { clear(); }
11 13 Sep 07 nicklas 148 }