001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/annotators/sql/SQLPersistenceTypeAnnotationHelper.java,v 1.1.1.1 2004/03/25 12:08:37 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:37 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruņa
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruņa nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040: package es.udc.mypersonalizer.kernel.model.annotators.sql;
041:
042: import es.udc.mypersonalizer.kernel.model.annotators.AnnotatedObject;
043: import es.udc.mypersonalizer.kernel.model.annotators.AnnotationHelper;
044: import es.udc.mypersonalizer.kernel.model.metainfo.MetaProperty;
045:
046: /**
047: * Utility class for accessing the persistence annotations specific for the
048: * SQL persistence type.
049: *
050: * @author Abel Muinho
051: * @since 1.0
052: */
053: public class SQLPersistenceTypeAnnotationHelper {
054:
055: public static final String TABLE_NAME_ANNOTATION = "tableName";
056: public static final String COLUMN_NAME_ANNOTATION = "columnName";
057: public static final String DB_TYPE_ANNOTATION = "dbType";
058: public static final String ID_COLUMN_ANNOTATION = "idColumn";
059: public static final String FK_COLUMN_ANNOTATION = "fkColumn";
060:
061: /** Hidden constructor. */
062: private SQLPersistenceTypeAnnotationHelper() {
063: }
064:
065: /** Obtains the table name annotation for the given object.
066: * @param o the annotated object.
067: * @return the value of the annotation on the object, or
068: * <code>null</code> if the annotation does not exist.
069: */
070: public final static String getTableNameAnnotation(AnnotatedObject o) {
071: return AnnotationHelper.getAnnotation(o, TABLE_NAME_ANNOTATION);
072: }
073:
074: /** Obtains the column name annotation for the given annotated object.
075: * @param o the annotated object.
076: * @return the value of the annotation on the annotated object, or
077: * <code>null</code> if the annotation does not exist.
078: */
079: public final static String getColumnNameAnnotation(AnnotatedObject o) {
080: return AnnotationHelper
081: .getAnnotation(o, COLUMN_NAME_ANNOTATION);
082: }
083:
084: /** Obtains the databse type annotation for the given annotated object.
085: * @param o the annotated object.
086: * @return the value of the annotation on the annotated object, or
087: * <code>null</code> if the annotation does not exist.
088: */
089: public final static String getDbTypeAnnotation(AnnotatedObject o) {
090: return AnnotationHelper.getAnnotation(o, DB_TYPE_ANNOTATION);
091: }
092:
093: /** Obtains the identifier column annotation for the given annotated
094: * object.
095: * @param o the annotated object.
096: * @return the value of the annotation on the annotated object, or
097: * <code>null</code> if the annotation does not exist.
098: */
099: public final static String getIdColumnAnnotation(AnnotatedObject o) {
100: return AnnotationHelper.getAnnotation(o, ID_COLUMN_ANNOTATION);
101: }
102:
103: /**
104: * Obtains the foreign key column annotation for the given annotated object.
105: * @param o the annotated object.
106: * @return the value of the annotation on the annotated object, or
107: * <code>null</code> if the annotation does not exist.
108: */
109: public static String getFKColumnAnnotation(AnnotatedObject o) {
110: return AnnotationHelper.getAnnotation(o, FK_COLUMN_ANNOTATION);
111: }
112:
113: }
|