001: /*
002: * $Id: TableOrganizationContext.java,v 1.1 2004/08/31 02:34:40 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2004 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: package org.axiondb;
041:
042: import java.util.Properties;
043: import java.util.Set;
044:
045: /**
046: * Table Organization Context.
047: *
048: * @author Ahimanikya Satapathy
049: * @version $Revision: 1.1 $ $Date: 2004/08/31 02:34:40 $
050: */
051: public interface TableOrganizationContext {
052: /**
053: * Gets table properties for this external table instance.
054: *
055: * @return Properties instance containing current table properties
056: */
057: Properties getTableProperties();
058:
059: /**
060: * Gets a Set of Strings representing valid property key names.
061: *
062: * @return Set of valid property key names
063: */
064: Set getPropertyKeys();
065:
066: Set getRequiredPropertyKeys();
067:
068: /**
069: * Gets a Set of Strings representing property key names that all ExternalTable
070: * instances should accept.
071: *
072: * @return Set of basic valid property key names
073: */
074: Set getBasePropertyKeys();
075:
076: /**
077: * Gets a Set of Strings representing property key names that all ExternalTable
078: * instances must require.
079: *
080: * @return Set of basic required property key names
081: */
082: Set getBaseRequiredPropertyKeys();
083:
084: /**
085: * Asserts that all property keys referenced in the given Properties instance are
086: * valid for the specific external table type.
087: *
088: * @param props Properties instance whose keys are to be checked
089: * @throws AxionException
090: */
091: void assertValidPropertyKeys(Properties props)
092: throws AxionException;
093:
094: void readOrSetDefaultProperties(Properties props)
095: throws AxionException;
096:
097: void updateProperties();
098:
099: void setProperty(String key, String value);
100: }
|