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.sql.framework.model;
042:
043: /**
044: * Interface describing column metadata for data sources providing information in a
045: * database or database-like format. Implementing classes must support the
046: * Cloneable interface.
047: *
048: * @author Sudhendra Seshachala, Jonathan Giron
049: */
050: public interface DBColumn extends Cloneable, Comparable {
051: /**
052: * Gets the column name
053: *
054: * @return column name
055: */
056: public String getName();
057:
058: /**
059: * Indicates whether this column is part of a primary key.
060: *
061: * @return true if this column is part of a primary key; false otherwise.
062: */
063: public boolean isPrimaryKey();
064:
065: /**
066: * Indicates whether this column is part of a foreign key.
067: *
068: * @return true if this column is part of a foreign key; false otherwise.
069: */
070: public boolean isForeignKey();
071:
072: /**
073: * Indicates whether this column is indexed.
074: *
075: * @return true if this column is indexed; false otherwise
076: */
077: public boolean isIndexed();
078:
079: /**
080: * Indicates whether this column can accept a null value.
081: *
082: * @return true if null is a valid value for this column, false otherwise.
083: */
084: public boolean isNullable();
085:
086: /**
087: * Gets the parent/owner (DBTable) of this column
088: *
089: * @return DBTable containing this column
090: */
091: public DBTable getParent();
092:
093: /**
094: * Gets the JDBC datatype for this column, as selected from the enumerated
095: * types in java.sql.Types.
096: *
097: * @return JDBC type value
098: * @see java.sql.Types
099: */
100: public int getJdbcType();
101:
102: /**
103: * Gets the JDBC datatype for this column, as a human-readable String.
104: *
105: * @return JDBC type value as a String
106: */
107: public String getJdbcTypeString();
108:
109: /**
110: * Gets the scale attribute of this column.
111: *
112: * @return scale
113: */
114: public int getScale();
115:
116: /**
117: * Gets the precision attribute of this column.
118: *
119: * @return precision
120: */
121: public int getPrecision();
122:
123: /**
124: * Gets the default value
125: * @return defaultValue
126: */
127: public String getDefaultValue();
128:
129: /**
130: * Gets the Ordinal Position
131: * @return int
132: */
133: public int getOrdinalPosition();
134: }
|