001: /*
002: * $Id: ExternalTable.java,v 1.11 2005/08/24 00:34:52 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2002-2005 Axion Development Team. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above
011: * copyright notice, this list of conditions and the following
012: * disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The names "Tigris", "Axion", nor the names of its contributors may
020: * not be used to endorse or promote products derived from this
021: * software without specific prior written permission.
022: *
023: * 4. Products derived from this software may not be called "Axion", nor
024: * may "Tigris" or "Axion" appear in their names without specific prior
025: * written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
028: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
029: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
030: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
031: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
032: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
033: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
034: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
035: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
036: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
037: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
038: * =======================================================================
039: */
040:
041: package org.axiondb;
042:
043: import java.util.Properties;
044:
045: /**
046: * Extends Table interface to accept configuration parameters associated with connecting a
047: * table to an external resource, such as a flatfile or external JDBC-compatible database.
048: * <p>
049: * Typically the external tables or data file are pre-existing so, we need to get more
050: * meta information about the data organization so that it can load those existing data
051: * file as Axion table.
052: *
053: * @version $Revision: 1.11 $ $Date: 2005/08/24 00:34:52 $
054: * @author Ahimanikya Satapathy
055: * @author Jonathan Giron
056: */
057: public interface ExternalTable extends Table {
058:
059: public static final String DELIMITED_TABLE_TYPE = "DELIMITED TEXT TABLE";
060: public static final String FW_TABLE_TYPE = "FIXED WIDTH TEXT TABLE";
061: public static final String TAGGED_EBCDIC_TABLE_TYPE = "TAGGED EBCDIC TABLE";
062: public static final String EXTERNAL_DB_TABLE_TYPE = "EXTERNAL DB TABLE";
063:
064: /** Property key name for catalog name */
065: public static final String PROP_CATALOG = "CATALOG";
066:
067: /** Property key name for database link */
068: public static final String PROP_DB = "DBLINK";
069:
070: /** Property key name for where filter */
071: public static final String PROP_ORDERBY = "ORDERBY";
072:
073: /** Property key name for remote table name */
074: public static final String PROP_REMOTETABLE = "REMOTETABLE";
075:
076: /** Property key name for schema name */
077: public static final String PROP_SCHEMA = "SCHEMA";
078:
079: /** Property key name for where filter */
080: public static final String PROP_WHERE = "WHERE";
081:
082: /** Property key representing specific table type to be built */
083: public static final String PROP_LOADTYPE = "LOADTYPE"; // NOI18N
084:
085: /** Property key representing (optional) DB vendor name for remote table */
086: public static final String PROP_VENDOR = "VENDOR"; // NOI18N
087:
088: public static final String COLUMNS_ARE_CASE_SENSITIVE = "COLUMNS_ARE_CASE_SENSITIVE";
089:
090: public static final String PROP_CREATE_IF_NOT_EXIST = "CREATE_IF_NOT_EXIST";
091:
092: /**
093: * Loads external data using the given properties table - should be called only once by
094: * the table factory.
095: *
096: * @param prop configuration properties for this external table
097: */
098: boolean loadExternalTable(Properties prop) throws AxionException;
099:
100: /**
101: * Gets Organization Property.
102: *
103: * @return Set of organization property key names;
104: */
105: Properties getTableProperties();
106:
107: void remount() throws AxionException;
108: }
|