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.sql.DatabaseMetaData;
027    
028    /**
029     * Provides RDBMS supported search ability as enumeration set.
030     * 
031     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
032     */
033    public enum SearchabilityType {
034    
035        NOT_SUPPORTED(DatabaseMetaData.typePredNone), // Indicates that <code>WHERE</code> search clauses are not supported for this
036                                                      // type.
037        WHERE_LIKE(DatabaseMetaData.typePredChar), // Indicates that the only <code>WHERE</code> search clause that can be based on
038                                                   // this type is <code>WHERE . . . LIKE</code>.
039        BASIC(DatabaseMetaData.typePredBasic), // Indicates that one can base all <code>WHERE</code> search clauses except <code>WHERE
040                                               // . . . LIKE</code> on this data type.
041        SEARCHABLE(DatabaseMetaData.typeSearchable); // Indicates that all <code>WHERE</code> search clauses can be based on this
042                                                     // type.
043    
044        private final int searchability;
045    
046        SearchabilityType( int searchability ) {
047            this.searchability = searchability;
048        }
049    
050        public int getSearchability() {
051            return searchability;
052        }
053    
054        public String getName() {
055            return name();
056        }
057    }