org.hibernate.tuple.IdentifierProperty.java Source code

Introduction

Here is the source code for org.hibernate.tuple.IdentifierProperty.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.tuple;

import org.hibernate.engine.spi.IdentifierValue;
import org.hibernate.id.IdentifierGenerator;
import org.hibernate.id.PostInsertIdentifierGenerator;
import org.hibernate.type.Type;

/**
 * Represents a defined entity identifier property within the Hibernate
 * runtime-metamodel.
 *
 * @author Steve Ebersole
 */
public class IdentifierProperty extends AbstractAttribute implements IdentifierAttribute {
    private boolean virtual;
    private boolean embedded;
    private IdentifierValue unsavedValue;
    private IdentifierGenerator identifierGenerator;
    private boolean identifierAssignedByInsert;
    private boolean hasIdentifierMapper;

    /**
     * Construct a non-virtual identifier property.
     *
     * @param name The name of the property representing the identifier within
     * its owning entity.
     * @param node The node name to use for XML-based representation of this
     * property.
     * @param type The Hibernate Type for the identifier property.
     * @param embedded Is this an embedded identifier.
     * @param unsavedValue The value which, if found as the value on the identifier
     * property, represents new (i.e., un-saved) instances of the owning entity.
     * @param identifierGenerator The generator to use for id value generation.
     */
    public IdentifierProperty(String name, Type type, boolean embedded, IdentifierValue unsavedValue,
            IdentifierGenerator identifierGenerator) {
        super(name, type);
        this.virtual = false;
        this.embedded = embedded;
        this.hasIdentifierMapper = false;
        this.unsavedValue = unsavedValue;
        this.identifierGenerator = identifierGenerator;
        this.identifierAssignedByInsert = identifierGenerator instanceof PostInsertIdentifierGenerator;
    }

    /**
     * Construct a virtual IdentifierProperty.
     *
     * @param type The Hibernate Type for the identifier property.
     * @param embedded Is this an embedded identifier.
     * @param unsavedValue The value which, if found as the value on the identifier
     * property, represents new (i.e., un-saved) instances of the owning entity.
     * @param identifierGenerator The generator to use for id value generation.
     */
    public IdentifierProperty(Type type, boolean embedded, boolean hasIdentifierMapper,
            IdentifierValue unsavedValue, IdentifierGenerator identifierGenerator) {
        super(null, type);
        this.virtual = true;
        this.embedded = embedded;
        this.hasIdentifierMapper = hasIdentifierMapper;
        this.unsavedValue = unsavedValue;
        this.identifierGenerator = identifierGenerator;
        this.identifierAssignedByInsert = identifierGenerator instanceof PostInsertIdentifierGenerator;
    }

    @Override
    public boolean isVirtual() {
        return virtual;
    }

    @Override
    public boolean isEmbedded() {
        return embedded;
    }

    @Override
    public IdentifierValue getUnsavedValue() {
        return unsavedValue;
    }

    @Override
    public IdentifierGenerator getIdentifierGenerator() {
        return identifierGenerator;
    }

    @Override
    public boolean isIdentifierAssignedByInsert() {
        return identifierAssignedByInsert;
    }

    @Override
    public boolean hasIdentifierMapper() {
        return hasIdentifierMapper;
    }

    @Override
    public String toString() {
        return "IdentifierAttribute(" + getName() + ")";
    }
}