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 table's best row identifies specific metadata. 030 * 031 * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a> 032 */ 033 public interface BestRowIdentifier extends CoreMetaData { 034 035 /** 036 * Return the scope of best row identifier 037 * 038 * @return the scope of best row identifier 039 */ 040 BestRowIdentifierScopeType getScopeType(); 041 042 /** 043 * Sets the scope of best row identifier 044 * 045 * @param scopeType the scope of best row identifier 046 */ 047 void setScopeType( BestRowIdentifierScopeType scopeType ); 048 049 /** 050 * Retrieves best row identifier columns 051 * 052 * @return best row identifier columns 053 */ 054 Set<Column> getColumns(); 055 056 /** 057 * Adds column to the best row identifier 058 * 059 * @param column the column that part of best row identifier 060 */ 061 void addColumn( Column column ); 062 063 /** 064 * Deletes column from the best row identifier 065 * 066 * @param column the column that no longer part of best row identifier 067 */ 068 void deleteColumn( Column column ); 069 070 /** 071 * Searches column by name 072 * 073 * @param columnName the column name to search 074 * @return column if found, otherwise return null 075 */ 076 Column findColumnByName( String columnName ); 077 }