001/*
002 * Copyright (c) 2004-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.dataproxy.datasource;
031
032import java.net.URL;
033
034/**
035 * <p>
036 * 
037 * Title:PlugInQueryTransferInterface
038 * </p>
039 * <p>
040 * 
041 * Description: This is a plugin interface and it defines a all methods any
042 * metadata type should implement into order to search ecogrid service and parse
043 * the results
044 * </p>
045 * <p>
046 * 
047 * Copyright: Copyright (c) 2004
048 * </p>
049 * <p>
050 * 
051 * Company:
052 * </p>
053 * 
054 *@author not attributable
055 *@created February 17, 2005
056 *@version 1.0
057 */
058
059public interface DataSourceInterface {
060        // Constant
061
062        public static final String ENDPOINT = "endpoint";
063        public static final String RECORDID = "recordid";
064        public static final String NAMESPACE = "namespace";
065
066        public static final String YELLOW = "{1.0, 1.0, 0.0, 1.0}";
067        public static final String RED = "{1.0, 0.0, 0.0, 1.0}";
068        public static final String BLACK = "{0.0, 0.0, 0.0, 1.0}";
069        public static final String MAGENTA = "{1.0, 0.0, 1.0, 1.0}";
070        public static final String TITLE_BINARY = "0101";
071        public static final String TITLE_BUSY = "BUSY";
072        public static final String TITLE_ERROR = "ERROR";
073
074        /**
075         * Get a URL pointer to the documentation for this data source.
076         * 
077         * @return URL the URL of the HTML file containing the documentation
078         */
079        public abstract URL getDocumentation();
080
081}