001 /*
002 * JBoss DNA (http://www.jboss.org/dna)
003 * See the COPYRIGHT.txt file distributed with this work for information
004 * regarding copyright ownership. Some portions may be licensed
005 * to Red Hat, Inc. under one or more contributor license agreements.
006 * See the AUTHORS.txt file in the distribution for a full listing of
007 * individual contributors.
008 *
009 * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010 * is licensed to you under the terms of the GNU Lesser General Public License as
011 * published by the Free Software Foundation; either version 2.1 of
012 * the License, or (at your option) any later version.
013 *
014 * JBoss DNA is distributed in the hope that it will be useful,
015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 * Lesser General Public License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this software; if not, write to the Free
021 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023 */
024 package org.jboss.dna.common.jdbc.model.api;
025
026 import java.util.Set;
027
028 /**
029 * Provides all database table's index specific metadata.
030 *
031 * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
032 */
033 public interface Index extends SchemaObject {
034
035 /**
036 * Retrieves index columns
037 *
038 * @return index columns
039 */
040 Set<IndexColumn> getColumns();
041
042 /**
043 * Adds IndexColumn
044 *
045 * @param indexColumn the IndexColumn
046 */
047 void addColumn( IndexColumn indexColumn );
048
049 /**
050 * delete IndexColumn
051 *
052 * @param indexColumn the IndexColumn
053 */
054 void deleteColumn( IndexColumn indexColumn );
055
056 /**
057 * Returns index column for specified column name or null
058 *
059 * @param columnName the name of column
060 * @return index column for specified column name or null.
061 */
062 IndexColumn findColumnByName( String columnName );
063
064 /**
065 * Can index values be non-unique. false when TYPE is tableIndexStatistic.
066 *
067 * @return true if index values can be non-unique.
068 */
069 Boolean isUnique();
070
071 /**
072 * Can index values be non-unique. false when TYPE is tableIndexStatistic.
073 *
074 * @param unique true if index values can be non-unique.
075 */
076 void setUnique( Boolean unique );
077
078 /**
079 * Gets index type
080 *
081 * @return index type
082 */
083 IndexType getIndexType();
084
085 /**
086 * Sets index type
087 *
088 * @param indexType index type
089 */
090 void setIndexType( IndexType indexType );
091
092 /**
093 * When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique
094 * values in the index.
095 *
096 * @return the number of rows in the table if index type is STATISTICS; otherwise, the number of unique values in the index.
097 */
098 Integer getCardinality();
099
100 /**
101 * When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique
102 * values in the index.
103 *
104 * @param cardinality the number of rows in the table if index type is STATISTICS; otherwise, the number of unique values in
105 * the index.
106 */
107 void setCardinality( Integer cardinality );
108
109 /**
110 * When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages
111 * used for the current index.
112 *
113 * @return the number of pages used for the table if index type is STATISTICS; otherwise the number of pages used for the
114 * current index.
115 */
116 Integer getPages();
117
118 /**
119 * When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages
120 * used for the current index.
121 *
122 * @param pages the number of pages used for the table if index type is STATISTICS; otherwise the number of pages used for the
123 * current index.
124 */
125 void setPages( Integer pages );
126
127 /**
128 * Returns the filter condition, if any. (may be null)
129 *
130 * @return the filter condition, if any. (may be null)
131 */
132 String getFilterCondition();
133
134 /**
135 * Sets the filter condition, if any. (may be null)
136 *
137 * @param filterCondition the filter condition, if any. (may be null)
138 */
139 void setFilterCondition( String filterCondition );
140 }