Android Open Source - ormdroid Type Mapping

From Project

Back to project page ormdroid.

License

The source code is released under:

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUC...

If you think the Android project ormdroid listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/*
 * Copyright 2012 Ross Bamford//from ww  w  .j  a v  a  2  s. c  om
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 */
package com.roscopeco.ormdroid;

import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;

import java.lang.reflect.Field;
import java.util.ArrayList;

/**
 * A mapping between Java types and SQL data. Implementations
 * of this interface are registered with the {@link TypeMapper}
 * class.
 */
public interface TypeMapping {
  /**
   * @return the Java type this mapping handles.
   */
  public Class<?> javaType();
  
  /**
   * @return the SQL type for the specified concrete Java type.
   */
  public String sqlType(Class<?> concreteType);

  /**
   * <p>Encode the specified value for storage in the database (i.e. for insertion
   * into an SQL INSERT or UPDATE statement).</p>
   * 
   * <p><strong>Note</strong>: The supplied database parameter may be null. If
   * this is the case then the framework does not expect any persistence to
   * take place during the call. Implementations <strong>must</strong> account
   * for this possibility, and <strong>may</strong> throw a sensible exception
   * (e.g. IllegalArgumentException) to indicate that they cannot handle the 
   * specified object without a database handle.</p>
   * 
   * <p>For an example of this, see {@link EntityTypeMapping}, which uses the 
   * database to persist transient objects. When the mapper is called during
   * query creation (with a null database) an exception is thrown, indicating
   * that it does not make sense to query for records matching a transient
   * object.</p>
   * 
   *  
   * @param db The {@link SQLiteDatabase} to use, or <code>null</code>.
   * @param value The value to encode.
   * 
   * @return An SQL compatible value string, suitably escaped for insertion into an SQL statement.
   */
  public String encodeValue(SQLiteDatabase db, Object value);
  
  /**
   * <p>Decode the specified SQL data to a Java object.</p>
   *  
   * @param db The {@link SQLiteDatabase} to use, or <code>null</code>.
   * @param field The field used to determine the Java type to return as well as inverse lookup names.
   * @param c The database cursor to read from.
   * @param columnIndex The column index containing the data.
   * @return An instance of <code>expectedType</code> representing the data.
   */
  public <T extends Entity> Object decodeValue(SQLiteDatabase db, Field field, Cursor c, int columnIndex, ArrayList<T> precursors);
}

Java Source Code List