schemacrawler.schema.ResultsColumn Maven / Gradle / Ivy
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2020, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------
SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.
You may elect to redistribute this code under any of these licenses.
The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html
The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/
========================================================================
*/
package schemacrawler.schema;
/**
* Represents a column in a result set.
*
* @author Sualeh Fatehi
*/
public interface ResultsColumn
extends BaseColumn
{
/**
* Gets the normal maximum number of characters allowed as the width of the
* designated column.
*
* @return The column's normal maximum width in characters
*/
int getDisplaySize();
/**
* Gets the column's suggested title for use in printouts and displays.
*
* @return Suggested column title
*/
String getLabel();
/**
* True if this column is auto-incremented.
*
* @return If the column is auto-incremented
*/
boolean isAutoIncrement();
/**
* True if this column is case-sensitive.
*
* @return If the column is case-sensitive
*/
boolean isCaseSensitive();
/**
* True if this column is a cash value.
*
* @return If the column is a cash value
*/
boolean isCurrency();
/**
* Indicates whether a write on the designated column will definitely
* succeed.
*
* @return Whether a write on the designated column will definitely succeed
*/
boolean isDefinitelyWritable();
/**
* Indicates whether the designated column is definitely not writable.
*
* @return Whether the designated column is definitely not writable
*/
boolean isReadOnly();
/**
* Indicates whether the designated column can be used in a where clause.
*
* @return Whether the designated column can be used in a where clause
*/
boolean isSearchable();
/**
* Indicates whether values in the designated column are signed numbers.
*
* @return Whether values in the designated column are signed numbers
*/
boolean isSigned();
/**
* Indicates whether it is possible for a write on the designated column to
* succeed.
*
* @return Whether it is possible for a write on the designated column to
* succeed
*/
boolean isWritable();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy