affyfusion-109/src/affymetrix/calvin/array/ArrayAttributes.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 physical array attributes. */
11 13 Sep 07 nicklas 28 public class ArrayAttributes {
11 13 Sep 07 nicklas 29
11 13 Sep 07 nicklas 30     /** A unique idendifier for the array object */
11 13 Sep 07 nicklas 31     private AffymetrixGuidType id;
11 13 Sep 07 nicklas 32
11 13 Sep 07 nicklas 33     /** The array attributes */
11 13 Sep 07 nicklas 34     private Vector /*ParameterNameValue*/ attributes;
11 13 Sep 07 nicklas 35
11 13 Sep 07 nicklas 36     /** The array name. */
11 13 Sep 07 nicklas 37     private String arrayName;
11 13 Sep 07 nicklas 38
11 13 Sep 07 nicklas 39     /** The barcode on the array cartridge. */
11 13 Sep 07 nicklas 40     private String arrayBarcode;
11 13 Sep 07 nicklas 41
11 13 Sep 07 nicklas 42     /** The type of assembly. */
11 13 Sep 07 nicklas 43     private int media;
11 13 Sep 07 nicklas 44
11 13 Sep 07 nicklas 45     /** The row number of the plate or strip. */
11 13 Sep 07 nicklas 46     private int mediaRow;
11 13 Sep 07 nicklas 47
11 13 Sep 07 nicklas 48     /** The column number of the plate or strip. */
11 13 Sep 07 nicklas 49     private int mediaCol;
11 13 Sep 07 nicklas 50
11 13 Sep 07 nicklas 51     /** A customer barcode. */
11 13 Sep 07 nicklas 52     private String customerBarcode;
11 13 Sep 07 nicklas 53
11 13 Sep 07 nicklas 54     /** The associated master file. */
11 13 Sep 07 nicklas 55     private String masterFile;
11 13 Sep 07 nicklas 56
11 13 Sep 07 nicklas 57     /** A unique idendifier for the master file */
11 13 Sep 07 nicklas 58     private AffymetrixGuidType masterFileId;
11 13 Sep 07 nicklas 59
11 13 Sep 07 nicklas 60     /** The method the probe array type was assigned. */
11 13 Sep 07 nicklas 61     private int patAssignment;
11 13 Sep 07 nicklas 62
11 13 Sep 07 nicklas 63     /** The date the array object was created. */
11 13 Sep 07 nicklas 64     private String creationDateTime;
11 13 Sep 07 nicklas 65
11 13 Sep 07 nicklas 66     /** The user who created the data object. */
11 13 Sep 07 nicklas 67     private String createdBy;
11 13 Sep 07 nicklas 68
11 13 Sep 07 nicklas 69     /** A user comment. */
11 13 Sep 07 nicklas 70     private String comment;
11 13 Sep 07 nicklas 71
11 13 Sep 07 nicklas 72     /** The step in Calvin that created the array set data. */
11 13 Sep 07 nicklas 73     private int createdStep;
11 13 Sep 07 nicklas 74
11 13 Sep 07 nicklas 75     /** The unique idendifier for the object.
11 13 Sep 07 nicklas 76      * @return The unique idendifier for the object.
11 13 Sep 07 nicklas 77      */
11 13 Sep 07 nicklas 78     public AffymetrixGuidType getIdentifier() { return id; }
11 13 Sep 07 nicklas 79
11 13 Sep 07 nicklas 80     /** The unique idendifier for the object.
11 13 Sep 07 nicklas 81      * @param value The unique idendifier for the object.
11 13 Sep 07 nicklas 82      */
11 13 Sep 07 nicklas 83     public void setIdentifier(AffymetrixGuidType value) { id = value; }
11 13 Sep 07 nicklas 84
11 13 Sep 07 nicklas 85     /** The array name.
11 13 Sep 07 nicklas 86      * @return The array name.
11 13 Sep 07 nicklas 87      */
11 13 Sep 07 nicklas 88     public String getArrayName() { return arrayName; }
11 13 Sep 07 nicklas 89
11 13 Sep 07 nicklas 90     /** The array name.
11 13 Sep 07 nicklas 91      * @param value The array name.
11 13 Sep 07 nicklas 92      */
11 13 Sep 07 nicklas 93     public void setArrayName(String value) { arrayName=value; }
11 13 Sep 07 nicklas 94
11 13 Sep 07 nicklas 95     /** The barcode on the array cartridge.
11 13 Sep 07 nicklas 96      * @return The barcode.
11 13 Sep 07 nicklas 97      */
11 13 Sep 07 nicklas 98     public String getArrayBarcode() { return arrayBarcode; }
11 13 Sep 07 nicklas 99
11 13 Sep 07 nicklas 100     /** The barcode on the array cartridge.
11 13 Sep 07 nicklas 101      * @param value The barcode.
11 13 Sep 07 nicklas 102      */
11 13 Sep 07 nicklas 103     public void setArrayBarcode(String value) { arrayBarcode=value; }
11 13 Sep 07 nicklas 104
11 13 Sep 07 nicklas 105     /** The type of assembly.
11 13 Sep 07 nicklas 106      * @return The assembly type.
11 13 Sep 07 nicklas 107      */
11 13 Sep 07 nicklas 108     public int getMedia() { return media; }
11 13 Sep 07 nicklas 109
11 13 Sep 07 nicklas 110     /** The type of assembly.
11 13 Sep 07 nicklas 111      * @param value The assembly type.
11 13 Sep 07 nicklas 112      */
11 13 Sep 07 nicklas 113     public void setMedia(int value) { media=value; }
11 13 Sep 07 nicklas 114
11 13 Sep 07 nicklas 115     /** The row number of the media or strip.
11 13 Sep 07 nicklas 116      * @return The row.
11 13 Sep 07 nicklas 117      */
11 13 Sep 07 nicklas 118     public int getMediaRow() { return mediaRow; }
11 13 Sep 07 nicklas 119
11 13 Sep 07 nicklas 120     /** The row number of the media or strip.
11 13 Sep 07 nicklas 121      * @param value The row.
11 13 Sep 07 nicklas 122      */
11 13 Sep 07 nicklas 123     public void setMediaRow(int value) { mediaRow=value; }
11 13 Sep 07 nicklas 124
11 13 Sep 07 nicklas 125     /** The column number of the media or strip.
11 13 Sep 07 nicklas 126      * @return The column.
11 13 Sep 07 nicklas 127      */
11 13 Sep 07 nicklas 128     public int getMediaCol() { return mediaCol; }
11 13 Sep 07 nicklas 129
11 13 Sep 07 nicklas 130     /** The column number of the media or strip.
11 13 Sep 07 nicklas 131      * @param value The column.
11 13 Sep 07 nicklas 132      */
11 13 Sep 07 nicklas 133     public void setMediaCol(int value) { mediaCol=value; }
11 13 Sep 07 nicklas 134
11 13 Sep 07 nicklas 135     /** A customer barcode.
11 13 Sep 07 nicklas 136      * @return The barcode.
11 13 Sep 07 nicklas 137      */
11 13 Sep 07 nicklas 138     public String getCustomerBarcode() { return customerBarcode; }
11 13 Sep 07 nicklas 139
11 13 Sep 07 nicklas 140     /** A customer barcode.
11 13 Sep 07 nicklas 141      * @param value The barcode.
11 13 Sep 07 nicklas 142      */
11 13 Sep 07 nicklas 143     public void setCustomerBarcode(String value) { customerBarcode=value; }
11 13 Sep 07 nicklas 144
11 13 Sep 07 nicklas 145     /** The associated master file.
11 13 Sep 07 nicklas 146      * @return The master file name.
11 13 Sep 07 nicklas 147      */
11 13 Sep 07 nicklas 148     public String getMasterFile() { return masterFile; }
11 13 Sep 07 nicklas 149
11 13 Sep 07 nicklas 150     /** The associated master file.
11 13 Sep 07 nicklas 151      * @param value The master file name.
11 13 Sep 07 nicklas 152      */
11 13 Sep 07 nicklas 153     public void setMasterFile(String value) { masterFile=value; }
11 13 Sep 07 nicklas 154
11 13 Sep 07 nicklas 155     /** The unique idendifier for the master file.
11 13 Sep 07 nicklas 156      * @return The master file guid.
11 13 Sep 07 nicklas 157      */
11 13 Sep 07 nicklas 158     public AffymetrixGuidType getMasterFileId() { return masterFileId; }
11 13 Sep 07 nicklas 159
11 13 Sep 07 nicklas 160     /** The unique idendifier for the master file.
11 13 Sep 07 nicklas 161      * @param value The master file guid.
11 13 Sep 07 nicklas 162      */
11 13 Sep 07 nicklas 163     public void setMasterFileId(AffymetrixGuidType value) { masterFileId=value; }
11 13 Sep 07 nicklas 164
11 13 Sep 07 nicklas 165     /** The method the probe array type was assigned.
11 13 Sep 07 nicklas 166      * @return The assignment method.
11 13 Sep 07 nicklas 167      */
11 13 Sep 07 nicklas 168     public int getPatAssignment() { return patAssignment; }
11 13 Sep 07 nicklas 169
11 13 Sep 07 nicklas 170     /** The method the probe array type was assigned.
11 13 Sep 07 nicklas 171      * @param value The assignment method.
11 13 Sep 07 nicklas 172      */
11 13 Sep 07 nicklas 173     public void setPatAssignment(int  value) { patAssignment=value; }
11 13 Sep 07 nicklas 174
11 13 Sep 07 nicklas 175     /** The date and time of initial creation.
11 13 Sep 07 nicklas 176      * @return The creation date and time.
11 13 Sep 07 nicklas 177      */
11 13 Sep 07 nicklas 178     public String getCreationDateTime() { return creationDateTime; }
11 13 Sep 07 nicklas 179
11 13 Sep 07 nicklas 180     /** The date and time of initial creation.
11 13 Sep 07 nicklas 181      * @param value The creation date and time.
11 13 Sep 07 nicklas 182      */
11 13 Sep 07 nicklas 183     public void setCreationDateTime(String value) { creationDateTime=value; }
11 13 Sep 07 nicklas 184
11 13 Sep 07 nicklas 185     /** The user who created the data object.
11 13 Sep 07 nicklas 186      * @return The user who created the data object.
11 13 Sep 07 nicklas 187      */
11 13 Sep 07 nicklas 188     public String getCreatedBy() { return createdBy; }
11 13 Sep 07 nicklas 189
11 13 Sep 07 nicklas 190     /** The user who created the data object.
11 13 Sep 07 nicklas 191      * @param value The user who created the data object.
11 13 Sep 07 nicklas 192      */
11 13 Sep 07 nicklas 193     public void setCreatedBy(String value) { createdBy=value; }
11 13 Sep 07 nicklas 194
11 13 Sep 07 nicklas 195     /** A user comment.
11 13 Sep 07 nicklas 196      * @return A user comment.
11 13 Sep 07 nicklas 197      */
11 13 Sep 07 nicklas 198     public String getComment() { return comment; }
11 13 Sep 07 nicklas 199
11 13 Sep 07 nicklas 200     /** A user comment.
11 13 Sep 07 nicklas 201      * @param value A user comment.
11 13 Sep 07 nicklas 202      */
11 13 Sep 07 nicklas 203     public void setComment(String value) { comment=value; }
11 13 Sep 07 nicklas 204
11 13 Sep 07 nicklas 205     /** The step in Calvin that created the array set data.
11 13 Sep 07 nicklas 206      * @return The step in calvin that create the array set data.
11 13 Sep 07 nicklas 207      */
11 13 Sep 07 nicklas 208     public int getCreatedStep() { return createdStep; }
11 13 Sep 07 nicklas 209
11 13 Sep 07 nicklas 210     /** The step in Calvin that created the array set data.
11 13 Sep 07 nicklas 211      * @param value The step in calvin that create the array set data.
11 13 Sep 07 nicklas 212      */
11 13 Sep 07 nicklas 213     public void setCreatedStep(int value) { createdStep=value; }
11 13 Sep 07 nicklas 214
11 13 Sep 07 nicklas 215     /** The array attributes.
11 13 Sep 07 nicklas 216      * @return The vector of array attributes.
11 13 Sep 07 nicklas 217      */
11 13 Sep 07 nicklas 218     public Vector /*ParameterNameValue*/ getAttributes() { return attributes; }
11 13 Sep 07 nicklas 219
11 13 Sep 07 nicklas 220     /** The array attributes.
11 13 Sep 07 nicklas 221      * @param value The vector of array attributes.
11 13 Sep 07 nicklas 222      */
11 13 Sep 07 nicklas 223     public void setAttributes(Vector /*ParameterNameValue*/ value) { attributes=value; }
11 13 Sep 07 nicklas 224
11 13 Sep 07 nicklas 225     /** Clears the member objects. */
11 13 Sep 07 nicklas 226     public void clear() {
11 13 Sep 07 nicklas 227         attributes=null;
11 13 Sep 07 nicklas 228   id=null;
11 13 Sep 07 nicklas 229   arrayName=null;
11 13 Sep 07 nicklas 230   arrayBarcode=null;
11 13 Sep 07 nicklas 231   media=ArrayMedia.CartridgeMedia;
11 13 Sep 07 nicklas 232   mediaRow=0;
11 13 Sep 07 nicklas 233   mediaCol=0;
11 13 Sep 07 nicklas 234   customerBarcode=null;
11 13 Sep 07 nicklas 235   masterFile=null;
11 13 Sep 07 nicklas 236   masterFileId=null;
11 13 Sep 07 nicklas 237   patAssignment=PATAssignmentMethod.NoAssignment;
11 13 Sep 07 nicklas 238   creationDateTime=null;
11 13 Sep 07 nicklas 239   createdBy=null;
11 13 Sep 07 nicklas 240   comment=null;
11 13 Sep 07 nicklas 241     }
11 13 Sep 07 nicklas 242     
11 13 Sep 07 nicklas 243     /** Constructs a new ArrayAttributes object. */
11 13 Sep 07 nicklas 244     public ArrayAttributes() {
11 13 Sep 07 nicklas 245         clear();
11 13 Sep 07 nicklas 246     }
11 13 Sep 07 nicklas 247 }