001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.mashup.db.model;
042:
043: import java.util.Map;
044: import org.netbeans.modules.sql.framework.model.DBConnectionDefinition;
045: import org.netbeans.modules.sql.framework.model.JDBCConnectionProvider;
046: import org.netbeans.modules.sql.framework.model.SQLDBModel;
047:
048: /**
049: * Root interface to be implemented by ETL-compatible flatfile data sources that provide
050: * information in a row-and-column addressable format. Extends DatabaseModel to support
051: * collection of flatfiles as analogues for a database instance of tables. This model
052: * represents a collection of one or more flatfiles in a single directory.
053: *
054: * @author Jonathan Giron
055: * @author Ahimanikya Satapathy
056: * @version $Revision$
057: */
058: public interface FlatfileDatabaseModel extends SQLDBModel,
059: JDBCConnectionProvider {
060:
061: /**
062: * Adds new SourceTable to the model.
063: *
064: * @param table new DBTable to add
065: */
066: void addTable(FlatfileDBTable table);
067:
068: /**
069: * Clones this object.
070: *
071: * @return shallow copy of this ETLDataSource
072: */
073: Object clone();
074:
075: /**
076: * Copies member values from those contained in the given FlatfileDatabaseModel
077: * instance.
078: *
079: * @param src DatabaseModel whose contents are to be copied into this instance
080: */
081: void copyFrom(FlatfileDatabaseModel src);
082:
083: /**
084: * @see java.lang.Object#equals
085: */
086: boolean equals(Object refObj);
087:
088: /**
089: * Gets name of DBConnectionDefinition associated with this database model.
090: *
091: * @return name of associated DBConnectionDefinition instance
092: */
093: String getConnectionName();
094:
095: /**
096: * Gets Flatfile instance, if any, whose file name matches the given String
097: *
098: * @param aName file name to search for
099: * @return matching instance, if any, or null if no Flatfile matches
100: * <code>aName</code>
101: */
102: FlatfileDBTable getFileMatchingFileName(String aName);
103:
104: /**
105: * Gets Flatfile instance, if any, whose table name matches the given String.
106: *
107: * @param tableName table name to search for
108: * @return matching instance, if any, or null if no Flatfile matches
109: * <code>aName</code>
110: */
111: FlatfileDBTable getFileMatchingTableName(String tableName);
112:
113: DBConnectionDefinition getFlatfileDBConnectionDefinition(
114: boolean download);
115:
116: Map getFlatfileTablePropertyMap(String flatfileName);
117:
118: Map getFlatfileTablePropertyMaps();
119:
120: int getMajorVersion();
121:
122: int getMicroVersion();
123:
124: int getMinorVersion();
125:
126: String getVersionString();
127:
128: /**
129: * Overrides default implementation to compute hashCode value for those members used
130: * in equals() for comparison.
131: *
132: * @return hash code for this object
133: * @see java.lang.Object#hashCode
134: */
135: int hashCode();
136:
137: /**
138: * Setter for FlatfileDBConnectionDefinition
139: *
140: * @param theConnectionDefinition to be set
141: */
142: void setConnectionDefinition(
143: DBConnectionDefinition theConnectionDefinition);
144:
145: /**
146: * Sets the Connection Name associated with connection name
147: *
148: * @param theConName associated with this DataSource
149: */
150: void setConnectionName(String theConName);
151:
152: /**
153: * Sets repository object, if any, providing underlying data for this DatabaseModel
154: * implementation.
155: *
156: * @param obj FlatfileDefinition hosting this object's metadata, or null if data are not
157: * held by a StcdbObjectTypeDefinition.
158: */
159: void setSource(FlatfileDefinition obj);
160:
161: /**
162: * Setter for tables
163: *
164: * @param theTables to be part of Model
165: */
166: void setTables(Map theTables);
167:
168: /**
169: * Overrides default implementation to return name of this DatabaseModel.
170: *
171: * @return model name.
172: */
173: String toString();
174:
175: }
|