001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. 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 copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.core.dataobjects.jdbc;
066:
067: import com.jcorporate.expresso.core.dataobjects.DataException;
068: import com.jcorporate.expresso.core.dataobjects.DataObjectMetaData;
069:
070: /**
071: * DataObject Metadata that is specific to JDBC implementations only. For example,
072: * TableName is absolutely meaningless in a non-JDBC environment. The DBObject
073: * metadata is derived from this interface
074: *
075: * @author Michael Rimov
076: * @since Expresso 5.1
077: */
078:
079: public interface JDBCObjectMetaData extends DataObjectMetaData {
080:
081: /**
082: * Return the Table Name of the current database object. Keep in mind
083: * that a database object could update or affect other tables as well.
084: *
085: * @return String: Table name of the target table of this database object
086: */
087: public String getTargetTable() throws DataException;
088:
089: /**
090: * Returns true if an Index exists for this array.
091: *
092: * @return true if this has an index
093: * Use getMetaData().hasIndex() instead
094: * @throws DataException upon error
095: */
096: public boolean hasIndex() throws DataException;
097:
098: /**
099: * Retrieve the database catalogue name associated with this data object
100: *
101: * @return the className of the schema associated with this DBObject
102: */
103: public String getTargetDbCatalog();
104:
105: /**
106: * Retrieve the full table name associated with this data object
107: *
108: * @param dataContext The target data context.
109: * @return the className of the schema associated with this DBObject
110: */
111: public String getTargetSQLTable(String dataContext)
112: throws DataException;
113:
114: /**
115: * Retrieve the database schema name associated with this data object
116: *
117: * @return the className of the schema associated with this DBObject
118: */
119: public String getTargetDbSchema();
120: }
|