package org.litesoft.orsup.selection; import org.litesoft.util.IllegalArgument; // Copyright Status: // // All Software available from LiteSoft.org (including this file) is // hereby released into the public domain. // // It is free! As in, you may use it freely in both commercial and // non-commercial applications, bundle it with your software // distribution, include it on a CD-ROM, list the source code in a book, // mirror the documentation at your own web site, or use it in any other // way you see fit. // // NO Warranty! // // All software is provided "as is". // // There is ABSOLUTELY NO WARRANTY OF ANY KIND: not for the design, fitness // (for a particular purpose), level of errors (or lack thereof), or // applicability of this software. The entire risk as to the quality // and performance of this software is with you. Should this software // prove defective, you assume the cost of all necessary servicing, repair // or correction. // // In no event unless required by applicable law or agreed to in writing // will any party who created or may modify and/or redistribute this // software, be liable to you for damages, including any general, // special, incidental or consequential damages arising out of the use or // inability to use this software (including but not limited to loss of // data or data being rendered inaccurate or losses sustained by you or // third parties or a failure of this software to operate with any // other programs), even if such holder or other party has been advised // of the possibility of such damages. // // NOTE: Should you discover a bug, have a recogmendation for a change, wish // to submit modifications, or wish to add new classes/functionality, // please email them to: // // changes44@litesoft.org // /** * An abstract helper class to make implementing SimpleColumnDefinition simpler.
* * Exceptions: All problems caught when the parameter(s) are checked (as * indicated/implied in the @param tags) will generate an IllegalArgumentException, * and means the API user has a problem. If a NullPointerException (or some * others, like: ClassCastException or ArrayIndexOutOfBoundsException) is thrown, * it means the API developer has a problem. Any Exception that is explicitly * thrown in the API, but unrelated to a parameter, will be listed in the throws * clause (and hopefully in the tag @throws). These may (but probably won't) be * checked Exceptions. * * @author George Smith * @version 1.03 02/07/02 Exception Policy, Use of IllegalArgument class. * @version 1.02 11/05/01 Completed? JavaDocs * @version 1.01 10/08/01 * @version 1.0 10/07/01 */ public abstract class AbstractColumnDefinition implements SimpleColumnDefinition { private String zName; private String zColumnName; private Class zColumnType; /** * Constructor that simply sets the attributes to support the * SimpleColumnDefinition interface.
* * @param pName Logical Column Name (!null). * @param pColumnName SQL Column Name (!null). * @param pColumnType Java Class type for the SQL Column Type (!null). */ protected AbstractColumnDefinition( String pName , String pColumnName , Class pColumnType ) { IllegalArgument.ifNull( "Name" , zName = pName); IllegalArgument.ifNull( "ColumnName" , zColumnName = pColumnName); IllegalArgument.ifNull( "ColumnType" , zColumnType = pColumnType); } /** * Accessor for the logical name of this Column.
* * While this name can be equal to the ColumnName, it does not need * to be, it could be the name of an Object's attribute that is mapped * to this column by an OR mapper. In any case, this name is what * is used/displayed by the specific WhereClause's toString() * method.
* * @return logical name of this Column.
* * @see WhereClause#toString() */ public final String getName() { return zName; } /** * Accessor for the actual SQL Column Name.
* * This ColumnName MUST match that declared in the SQL Table Meta-data, * as it is used/displayed by the specific WhereClause's toSQL() * method.
* * @return SQL Column Name.
* * @see WhereClause#toSQL() */ public final String getColumnName() { return zColumnName; } /** * Accessor for the Java Class type of the SQL Column.
* * The primary purpose of this method (within the WhereClause * infrastructure) is to indicate (to the toString() and toSQL() methods) * how the values should be formatted/displayed. (e.g. that Strings * must be quote safe and non-Strings must use thier toString() * method to format)
* * @return Java Class type of the SQL Column.
* * @see WhereClause#toSQL() * @see WhereClause#toString() */ public final Class getColumnType() { return zColumnType; } }