01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.mashup.db.bootstrap;
42:
43: import java.util.List;
44:
45: import org.netbeans.modules.mashup.db.common.FlatfileDBException;
46: import org.netbeans.modules.mashup.db.model.FlatfileDBTable;
47:
48: /**
49: * Simple interface defining a parser to be used by the Flatfile Database wizard to obtain
50: * an initial set of FlatfileField instances to present to the user in the record layout
51: * configuration panel.
52: *
53: * @author Jonathan Giron
54: * @author Ahimanikya Satapathy
55: * @version $Revision$
56: */
57: public interface FlatfileBootstrapParser {
58:
59: /**
60: * Gets List of FlatfileDBColumn instances which are derived from the parse properties
61: * of the currently associated ParseConfigurator and the given Flatfile instance.
62: *
63: * @param table FlatfileDBTable whose contents will be parsed.
64: * @return List of FlatfileDBColumn instances synthesized from the contents of
65: * <code>file</code> and parameters contained in the current FlatfileDBTable
66: * @throws FlatfileDBException if error occurs during retrieval
67: */
68: public List buildFlatfileDBColumns(FlatfileDBTable table)
69: throws FlatfileDBException;
70:
71: /**
72: * Based on the given file guess the record length and other properties
73: *
74: * @param table
75: * @throws FlatfileDBException
76: */
77: public void makeGuess(FlatfileDBTable table)
78: throws FlatfileDBException;
79:
80: /**
81: * Is this file format acceptable by this parser
82: *
83: * @param table
84: * @return
85: * @throws FlatfileDBException
86: */
87: public boolean acceptable(FlatfileDBTable table)
88: throws FlatfileDBException;
89: }
|