/**********************************************************************
Copyright (c) 2009 Andy Jefferson and others. All rights reserved.
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.
Contributors:
...
**********************************************************************/
package org.datanucleus.store.mapped.mapping;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import org.datanucleus.ClassLoaderResolver;
import org.datanucleus.ExecutionContext;
import org.datanucleus.FetchPlan;
import org.datanucleus.api.ApiAdapter;
import org.datanucleus.exceptions.NucleusException;
import org.datanucleus.identity.IdentityUtils;
import org.datanucleus.identity.OIDFactory;
import org.datanucleus.metadata.AbstractClassMetaData;
import org.datanucleus.metadata.AbstractMemberMetaData;
import org.datanucleus.metadata.ClassMetaData;
import org.datanucleus.state.ObjectProvider;
import org.datanucleus.store.FieldValues;
import org.datanucleus.store.fieldmanager.FieldManager;
import org.datanucleus.store.mapped.DatastoreClass;
import org.datanucleus.store.mapped.StatementClassMapping;
import org.datanucleus.store.mapped.StatementMappingIndex;
import org.datanucleus.util.ClassUtils;
import org.datanucleus.util.Localiser;
import org.datanucleus.util.NucleusLogger;
/**
* Helper class for handling mappings.
*/
public class MappingHelper
{
/** Localiser for messages */
protected static final Localiser LOCALISER = Localiser.getInstance(
"org.datanucleus.Localisation", org.datanucleus.ClassConstants.NUCLEUS_CONTEXT_LOADER);
/**
* Convenience method to return an array of positions for datastore columns for the supplied
* mapping and the initial position value. For example if the mapping has a single datastore
* column and the initial position is 1 then returns the array {1}.
* @param initialPosition the initialPosition
* @param mapping the Mapping
* @return an array containing indexes for parameters
*/
public static int[] getMappingIndices(int initialPosition, JavaTypeMapping mapping)
{
if (mapping.getNumberOfDatastoreMappings() < 1)
{
return new int[]{initialPosition};
}
int parameter[] = new int[mapping.getNumberOfDatastoreMappings()];
for (int i=0; i<parameter.length; i++)
{
parameter[i] = initialPosition+i;
}
return parameter;
}
/**
* Get the object instance for a class using datastore identity
* @param ec ExecutionContext
* @param mapping The mapping in which this is returned
* @param rs the ResultSet
* @param resultIndexes indexes for the result set
* @param cmd the AbstractClassMetaData
* @return the id
*/
public static Object getObjectForDatastoreIdentity(ExecutionContext ec, JavaTypeMapping mapping,
final Object rs, int[] resultIndexes, AbstractClassMetaData cmd)
{
// Datastore Identity - retrieve the OID for the class.
// Note that this is a temporary OID that is simply formed from the type of base class in the relationship
// and the id stored in the FK. The real OID for the object may be of a different class.
// For that reason we get the object by checking the inheritance (final param in getObjectById())
Object oid = null;
if (mapping.getNumberOfDatastoreMappings() > 0)
{
oid = mapping.getDatastoreMapping(0).getObject(rs, resultIndexes[0]);
}
else
{
// 1-1 bidirectional "mapped-by" relation, so use ID mappings of related class to retrieve the value
if (mapping.getReferenceMapping() != null) //TODO why is it null for PC concrete classes?
{
return mapping.getReferenceMapping().getObject(ec, rs, resultIndexes);
}
Class fieldType = mapping.getMemberMetaData().getType();
JavaTypeMapping referenceMapping = mapping.getStoreManager().getDatastoreClass(fieldType.getName(), ec.getClassLoaderResolver()).getIdMapping();
oid = referenceMapping.getDatastoreMapping(0).getObject(rs, resultIndexes[0]);
}
if (oid != null)
{
oid = OIDFactory.getInstance(ec.getNucleusContext(), mapping.getType(), oid);
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(LOCALISER.msg("041034",oid));
}
}
ApiAdapter api = ec.getApiAdapter();
if (api.isPersistable(oid)) //why check this?
{
return oid;
}
return oid == null ? null : ec.findObject(oid, false, true, null);
}
/**
* Get the object instance for a class using application identity
* @param ec ExecutionContext
* @param mapping The mapping in which this is returned
* @param rs the ResultSet
* @param resultIndexes indexes in the result set to retrieve
* @param cmd the AbstractClassMetaData
* @return the id
*/
public static Object getObjectForApplicationIdentity(final ExecutionContext ec, JavaTypeMapping mapping,
final Object rs, int[] resultIndexes, AbstractClassMetaData cmd)
{
ClassLoaderResolver clr = ec.getClassLoaderResolver();
// Abstract class
if (((ClassMetaData)cmd).isAbstract() && cmd.getObjectidClass() != null)
{
return getObjectForAbstractClass(ec, mapping, rs, resultIndexes, cmd);
}
int totalFieldCount = cmd.getNoOfManagedMembers() + cmd.getNoOfInheritedManagedMembers();
final StatementMappingIndex[] statementExpressionIndex = new StatementMappingIndex[totalFieldCount];
int paramIndex = 0;
DatastoreClass datastoreClass = mapping.getStoreManager().getDatastoreClass(cmd.getFullClassName(), clr);
final int[] pkFieldNumbers = cmd.getPKMemberPositions();
for (int i=0; i<pkFieldNumbers.length; ++i)
{
AbstractMemberMetaData fmd = cmd.getMetaDataForManagedMemberAtAbsolutePosition(pkFieldNumbers[i]);
JavaTypeMapping m = datastoreClass.getMemberMapping(fmd);
statementExpressionIndex[fmd.getAbsoluteFieldNumber()] = new StatementMappingIndex(m);
int expressionsIndex[] = new int[m.getNumberOfDatastoreMappings()];
for (int j = 0; j < expressionsIndex.length; j++)
{
expressionsIndex[j] = resultIndexes[paramIndex++];
}
statementExpressionIndex[fmd.getAbsoluteFieldNumber()].setColumnPositions(expressionsIndex);
}
final StatementClassMapping resultMappings = new StatementClassMapping();
for (int i=0;i<pkFieldNumbers.length;i++)
{
resultMappings.addMappingForMember(pkFieldNumbers[i], statementExpressionIndex[pkFieldNumbers[i]]);
}
// TODO Use any other (non-PK) param values
final FieldManager resultsFM = mapping.getStoreManager().getFieldManagerForResultProcessing(ec, rs, resultMappings, cmd);
Object id = IdentityUtils.getApplicationIdentityForResultSetRow(ec, cmd, null, false, resultsFM);
Class type = ec.getClassLoaderResolver().classForName(cmd.getFullClassName());
return ec.findObject(id, new FieldValues()
{
public void fetchFields(ObjectProvider sm)
{
sm.replaceFields(pkFieldNumbers, resultsFM);
}
public void fetchNonLoadedFields(ObjectProvider sm)
{
sm.replaceNonLoadedFields(pkFieldNumbers, resultsFM);
}
public FetchPlan getFetchPlanForLoading()
{
return ec.getFetchPlan();
}
}, type, false, true);
}
/**
* Create a SingleFieldIdentity instance
* @param ec ExecutionContext
* @param mapping Mapping in which this is returned
* @param rs the ResultSet
* @param param the parameters
* @param cmd the AbstractClassMetaData
* @param objectIdClass the object id class
* @param pcClass the PersistenceCapable class
* @return the id
*/
protected static Object createSingleFieldIdentity(ExecutionContext ec, JavaTypeMapping mapping, final Object rs,
int[] param, AbstractClassMetaData cmd, Class objectIdClass, Class pcClass)
{
// SingleFieldIdentity
int paramNumber = param[0];
try
{
Object idObj = mapping.getStoreManager().getResultValueAtPosition(rs, mapping, paramNumber);
if (idObj == null)
{
throw new NucleusException(LOCALISER.msg("041039")).setFatal();
}
else
{
// Make sure the key type is correct for the type of SingleFieldIdentity
Class keyType = ec.getApiAdapter().getKeyTypeForSingleFieldIdentityType(objectIdClass);
idObj = ClassUtils.convertValue(idObj, keyType);
}
return ec.getApiAdapter().getNewSingleFieldIdentity(objectIdClass, pcClass, idObj);
}
catch (Exception e)
{
NucleusLogger.PERSISTENCE.error(LOCALISER.msg("041036", cmd.getObjectidClass(), e));
return null;
}
}
/**
* Create an object id instance and fill the fields using reflection
* @param ec ExecutionContext
* @param mapping Mapping in which this is returned
* @param rs the ResultSet
* @param param the parameters
* @param cmd the AbstractClassMetaData
* @param objectIdClass the object id class
* @return the id
*/
protected static Object createObjectIdInstanceReflection(ExecutionContext ec, JavaTypeMapping mapping, final Object rs,
int[] param, AbstractClassMetaData cmd, Class objectIdClass)
{
// Users own AID
Object fieldValue = null;
try
{
// Create an AID
Object id = objectIdClass.newInstance();
// Set the fields of the AID
int paramIndex = 0;
int[] pkFieldNums = cmd.getPKMemberPositions();
for (int i=0; i<pkFieldNums.length; ++i)
{
AbstractMemberMetaData fmd = cmd.getMetaDataForManagedMemberAtAbsolutePosition(pkFieldNums[i]);
Field field = objectIdClass.getField(fmd.getName());
JavaTypeMapping m = mapping.getStoreManager().getDatastoreClass(cmd.getFullClassName(), ec.getClassLoaderResolver()).getMemberMapping(fmd);
// NOTE This assumes that each field has one datastore column.
for (int j = 0; j < m.getNumberOfDatastoreMappings(); j++)
{
Object obj = mapping.getStoreManager().getResultValueAtPosition(rs, mapping, param[paramIndex++]);
if ((obj instanceof BigDecimal))
{
BigDecimal bigDecimal = (BigDecimal) obj;
// Oracle 10g returns BigDecimal for NUMBER columns, resulting in IllegalArgumentException
// when reflective setter is invoked for incompatible field type
// (see http://www.jpox.org/servlet/jira/browse/CORE-2624)
Class keyType = ec.getApiAdapter().getKeyTypeForSingleFieldIdentityType(field.getType());
obj = ClassUtils.convertValue(bigDecimal, keyType);
if (!bigDecimal.subtract(new BigDecimal("" + obj)).equals(new BigDecimal("0")))
{
throw new NucleusException("Cannot convert retrieved BigInteger value to field of object id class!").setFatal();
}
}
// field with multiple columns should have values returned from db merged here
fieldValue = obj;
}
field.set(id, fieldValue);
}
return id;
}
catch (Exception e)
{
AbstractMemberMetaData mmd = mapping.getMemberMetaData();
NucleusLogger.PERSISTENCE.error(LOCALISER.msg("041037",
cmd.getObjectidClass(), mmd == null ? null : mmd.getName(), fieldValue, e));
return null;
}
}
/**
* Create an object id instance and fill the fields using reflection
* @param ec ExecutionContext
* @param mapping Mapping in which this is returned
* @param rs the ResultSet
* @param resultIndexes indexes of the result set to use
* @param cmd the AbstractClassMetaData
* @return the id
*/
protected static Object getObjectForAbstractClass(ExecutionContext ec, JavaTypeMapping mapping, final Object rs,
int[] resultIndexes, AbstractClassMetaData cmd)
{
ClassLoaderResolver clr = ec.getClassLoaderResolver();
// Abstract class, so we need to generate an id before proceeding
Class objectIdClass = clr.classForName(cmd.getObjectidClass());
Class pcClass = clr.classForName(cmd.getFullClassName());
Object id;
if (cmd.usesSingleFieldIdentityClass())
{
id = createSingleFieldIdentity(ec, mapping, rs, resultIndexes, cmd, objectIdClass, pcClass);
}
else
{
id = createObjectIdInstanceReflection(ec, mapping, rs, resultIndexes, cmd, objectIdClass);
}
return ec.findObject(id, false, true, null);
}
}