001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.ejb.plugins.cmp.jdbc.metadata;
023:
024: import java.sql.Types;
025:
026: import org.jboss.deployment.DeploymentException;
027: import org.jboss.logging.Logger;
028:
029: import org.jboss.metadata.MetaData;
030: import org.w3c.dom.Element;
031:
032: /**
033: * Imutable class which holds a mapping between a Java Class and a JDBC type
034: * and a SQL type.
035: *
036: * @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
037: * @author <a href="sebastien.alborini@m4x.org">Sebastien Alborini</a>
038: * @version $Revision: 57209 $
039: */
040: public final class JDBCMappingMetaData {
041: private static Logger log = Logger
042: .getLogger(JDBCMappingMetaData.class.getName());
043:
044: /**
045: * Gets the JDBC type constant int for the name. The mapping from name to jdbc
046: * type is contained in java.sql.Types.
047: *
048: * @param name the name for the jdbc type
049: * @return the int type constant from java.sql.Types
050: * @see java.sql.Types
051: */
052: public static int getJdbcTypeFromName(String name)
053: throws DeploymentException {
054: if (name == null) {
055: throw new DeploymentException("jdbc-type cannot be null");
056: }
057:
058: try {
059: Integer constant = (Integer) Types.class.getField(name)
060: .get(null);
061: return constant.intValue();
062:
063: } catch (Exception e) {
064: log.warn("Unrecognized jdbc-type: " + name
065: + ", using Types.OTHER", e);
066: return Types.OTHER;
067: }
068: }
069:
070: /** fully qualified Java type name */
071: private final String javaType;
072: /** JDBC type according to java.sql.Types */
073: private final int jdbcType;
074: /** SQL type */
075: private final String sqlType;
076: /** parameter setter */
077: private final String paramSetter;
078: /** result set reader */
079: private final String resultReader;
080:
081: /**
082: * Constructs a mapping with the data contained in the mapping xml element
083: * from a jbosscmp-jdbc xml file.
084: *
085: * @param element the xml Element which contains the metadata about
086: * this mapping
087: * @throws DeploymentException if the xml element is not semantically correct
088: */
089: public JDBCMappingMetaData(Element element)
090: throws DeploymentException {
091: javaType = MetaData.getUniqueChildContent(element, "java-type");
092: jdbcType = getJdbcTypeFromName(MetaData.getUniqueChildContent(
093: element, "jdbc-type"));
094: sqlType = MetaData.getUniqueChildContent(element, "sql-type");
095: paramSetter = MetaData.getOptionalChildContent(element,
096: "param-setter");
097: resultReader = MetaData.getOptionalChildContent(element,
098: "result-reader");
099: }
100:
101: /**
102: * Gets the java type of this mapping. The java type is used to differentiate
103: * this mapping from other mappings.
104: *
105: * @return the java type of this mapping
106: */
107: public String getJavaType() {
108: return javaType;
109: }
110:
111: /**
112: * Gets the jdbc type of this mapping. The jdbc type is used to retrieve data
113: * from a result set and to set parameters in a prepared statement.
114: *
115: * @return the jdbc type of this mapping
116: */
117: public int getJdbcType() {
118: return jdbcType;
119: }
120:
121: /**
122: * Gets the sql type of this mapping. The sql type is the sql column data
123: * type, and is used in CREATE TABLE statements.
124: *
125: * @return the sql type String of this mapping
126: */
127: public String getSqlType() {
128: return sqlType;
129: }
130:
131: public String getParamSetter() {
132: return paramSetter;
133: }
134:
135: public String getResultReader() {
136: return resultReader;
137: }
138: }
|