001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.objectmanager.data.db;
031
032import java.util.Vector;
033
034/**
035 * Interface to description a table field
036 */
037public interface DSTableFieldIFace {
038        /**
039         * Returns one or more names. A single name for a single field or key.
040         * Multiple names for a key with multiple fields
041         * 
042         * @return String of type in format "XXXX, XXXX, XXXX"
043         */
044        public String getName();
045
046        /**
047         * Passes back one or more types in human readable string may want to change
048         * this to an array of type or a vector
049         * 
050         * @return String of type in format "XXXX, XXXX, XXXX"
051         */
052        public String getDataType();
053
054        /**
055         * Method to return the vector which store the missing value code. If this
056         * attribute doesn't has the missing value code, empty vector will be
057         * returned.
058         * 
059         *       */
060        public Vector getMissingValueCode();
061
062        /**
063         * Method to set up missing value code for this field
064         * 
065         * @param missingValueCode
066         */
067        public void addMissingValueCode(String missingValueCode);
068
069        /**
070         * Method to set up missing value code for this field
071         * 
072         * @param missingValueCode
073         */
074        public void setMissingValueCode(Vector missingValueCode);
075
076}