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.spi;
025
026 import java.util.Set;
027 import java.util.HashSet;
028 import org.jboss.dna.common.jdbc.model.api.BestRowIdentifier;
029 import org.jboss.dna.common.jdbc.model.api.BestRowIdentifierScopeType;
030 import org.jboss.dna.common.jdbc.model.api.Column;
031
032 /**
033 * Provides table's best row identifies specific metadata.
034 *
035 * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
036 */
037 public class BestRowIdentifierBean extends CoreMetaDataBean implements BestRowIdentifier {
038 private static final long serialVersionUID = -6031029115876541704L;
039 private BestRowIdentifierScopeType scopeType;
040 private Set<Column> columns = new HashSet<Column>();
041
042 /**
043 * Default constructor
044 */
045 public BestRowIdentifierBean() {
046 }
047
048 /**
049 * Return the scope of best row identifier
050 *
051 * @return the scope of best row identifier
052 */
053 public BestRowIdentifierScopeType getScopeType() {
054 return scopeType;
055 }
056
057 /**
058 * Sets the scope of best row identifier
059 *
060 * @param scopeType the scope of best row identifier
061 */
062 public void setScopeType( BestRowIdentifierScopeType scopeType ) {
063 this.scopeType = scopeType;
064 }
065
066 /**
067 * Retrieves best row identifier columns
068 *
069 * @return best row identifier columns
070 */
071 public Set<Column> getColumns() {
072 return columns;
073 }
074
075 /**
076 * Adds column to the best row identifier
077 *
078 * @param column the column that part of best row identifier
079 */
080 public void addColumn( Column column ) {
081 columns.add(column);
082 }
083
084 /**
085 * Deletes column from the best row identifier
086 *
087 * @param column the column that no longer part of best row identifier
088 */
089 public void deleteColumn( Column column ) {
090 columns.remove(column);
091 }
092
093 /**
094 * Searches column by name
095 *
096 * @param columnName the column name to search
097 * @return column if found, otherwise return null
098 */
099 public Column findColumnByName( String columnName ) {
100 for (Column c : columns) {
101 if (c.getName().equals(columnName)) {
102 return c;
103 }
104 }
105 // return nothing
106 return null;
107 }
108 }