SimpleNaturalKeyFactory.java :  » Database-ORM » ODAL » com » completex » objective » components » persistency » key » Java Open Source

/**
 *  Objective Database Abstraction Layer (ODAL)
 *  Copyright (c) 2004, The ODAL Development Group
 *  All rights reserved.
 *  For definition of the ODAL Development Group please refer to LICENCE.txt file
 *
 *  Distributable under LGPL license.
 *  See terms of license at gnu.org.
 */
package com.completex.objective.components.persistency.key;

import com.completex.objective.components.persistency.PersistentObject;

/**
 * Factory of SimpleNaturalKey objects
 * 
 * @see SimpleNaturalKey
 * 
 * @author Gennady Krizhevsky
 */
public interface SimpleNaturalKeyFactory {

    /**
     * Creates SimpleNaturalKey based on PersistentObject and its key column indeces
     * 
     * @param persistent parent PersistentObject
     * @param keyIndeces key column indeces used to create this key
     * @return key new key instance
     */
    SimpleNaturalKey newSimpleNaturalKey(PersistentObject persistent, int[] keyIndeces);

    /**
     * Creates SimpleNaturalKey based on class name and array of values
     * 
     * @param className class name
     * @param values array of values
     * @return key new key instance
     */
    SimpleNaturalKey newSimpleNaturalKey(String className, Object[] values);
}