/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  All rights reserved.
  
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR 
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.sqldatabase;

import java.lang.reflect.Method;

/**
 * Represents the way fields within an instance of SqlPersistentObejct are
 * stored and retrieved from an SQL database.
 * 
 * @author Jon Maber
 * @version 1
 */

class SqlField extends Object
	{

	/**
	 * Flag indicates that this is a primary key field.
	 */
	static final int PK = 1;

	/**
	 * Flag indicates that this is a foreign key field.
	 */
	static final int FK = 2;

	/**
	 * Which data type does this field belong to.
	 */
	
	int type;

	/**
	 * The column name in the database table for this field.
	 */
	String field;

	/**
	 * The method name for setting this field value.
	 */
	String set_method_name;

	/**
	 * The method name for getting this field value.
	 */
	String get_method_name;

	/**
	 * The name of the class passed to the set method.
	 */
	String set_java_class;

	/**
	 * The name of the class returned from the get method.
	 */
	String get_java_class;

	/**
	 * Indicates whether the field is a primary or foreign key.
	 */
	int flags;

	/**
	 * For foreign keys gives the class type of the foreign object referenced.
	 * (In the future 0 may indicate any subclass of PersistentObject.)
	 */
	
	int foreign_type;

	/**
	 * Name of method to set reference to foreign object.
	 */
	String set_method_name_foreign;

	/**
	 * Name of method to get reference to foreign object.
	 */
	String get_method_name_foreign;

	/**
	 * Actual Method for setting value.
	 */
	
	Method set_method;

	/**
	 * Actual Method for gsetting value.
	 */
	Method get_method;

	/**
	 * Actual Method for setting foreign value.
	 */
	Method set_method_foreign;

	/**
	 * Actual Method for getting foreign value.
	 */
	Method get_method_foreign;

	/**
	 * The SQL data type used in the database for the column named  after field.
	 */
	
	int sql_type;

	/**
	 * The precision of the SQL data type (for variable scale types).
	 */
	
	int sql_precision;
	/**
	 * The scale of the SQL data type (for variable scale types).
	 */
	
	int sql_scale;
	}