oracle.toplink.essentials.descriptors.ClassExtractor Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.descriptors;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.sessions.*;
import oracle.toplink.essentials.descriptors.ClassDescriptor;
/**
* Purpose:
* Abstract class to allow complex inheritance support. Typically class indicators are used to define inheritance in the database,
* however in complex cases the class type may be determined through another mechanism.
* The class extractor must be able to determine and return the class type from the database row.
*
* @see oracle.toplink.essentials.descriptors.InheritancePolicy#setClassExtractor(ClassExtrator)
*/
public abstract class ClassExtractor {
/**
* Extract/compute the class from the database row and return the class.
* Map is used as the public interface to database row, the key is the field name,
* the value is the database value.
*/
public abstract Class extractClassFromRow(Record databaseRow, Session session);
/**
* Allow for any initialization.
*/
public void initialize(ClassDescriptor descriptor, Session session) throws DescriptorException {
// Do nothing by default.
}
}