All Downloads are FREE. Search and download functionalities are using the official Maven repository.

oracle.toplink.essentials.tools.schemaframework.SequenceObjectDefinition Maven / Gradle / Ivy

There is a newer version: 2.1-60f
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * // Copyright (c) 1998, 2007, Oracle. All rights reserved.
 * 
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package oracle.toplink.essentials.tools.schemaframework;

import java.io.*;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.sequencing.Sequence;
import oracle.toplink.essentials.internal.sessions.AbstractSession;

/**
 * 

* Purpose: Sequence definition Native Sequence object. *

*/ public class SequenceObjectDefinition extends SequenceDefinition { /** * INTERNAL: * Should be a sequence defining sequence object in the db: * either NativeSequence with shouldAcquireValueAfterInsert() returning false; * or DefaultSequence (only if case platform.getDefaultSequence() is a * NativeSequence with shouldAcquireValueAfterInsert() returning false). */ public SequenceObjectDefinition(Sequence sequence) { super(sequence); } /** * INTERNAL: * Return the SQL required to create the Oracle sequence object. */ public Writer buildCreationWriter(AbstractSession session, Writer writer) { try { // startWith value calculated using the initial value and increment. // The first time TopLink calls select nextval, the value equal to startWith is returned. // The first sequence value TopLink may assign is startWith - getIncrement() + 1. int startWith = sequence.getInitialValue() + sequence.getPreallocationSize() - 1; session.getPlatform().buildSequenceObjectCreationWriter(writer, getFullName(), sequence.getPreallocationSize(), startWith); } catch (IOException ioException) { throw ValidationException.fileError(ioException); } return writer; } /** * INTERNAL: * Return the SQL required to drop the Oracle sequence object. */ public Writer buildDeletionWriter(AbstractSession session, Writer writer) { try { session.getPlatform().buildSequenceObjectDeletionWriter(writer, getFullName()); } catch (IOException ioException) { throw ValidationException.fileError(ioException); } return writer; } /** * INTERNAL: * Return the SQL required to alter INCREMENT BY */ public Writer buildAlterIncrementWriter(AbstractSession session, Writer writer) { try { session.getPlatform().buildSequenceObjectAlterIncrementWriter(writer, getFullName(), sequence.getPreallocationSize()); } catch (IOException ioException) { throw ValidationException.fileError(ioException); } return writer; } /** * INTERNAL: * Check if the sequence object already exists, in which case dont create it. */ public boolean checkIfExist(AbstractSession session) throws DatabaseException { boolean isConnected = sequence.isConnected(); // temporary connect sequence if it's not connected. if(!isConnected) { sequence.onConnect(session.getPlatform()); } try { if(sequence.shouldUsePreallocation()) { sequence.getGeneratedVector(null, session); } else { sequence.getGeneratedValue(null, session); } return true; } catch (DatabaseException databaseException) { return false; } catch (ValidationException validationException) { // This exception indicates that the current preallocationSize // is greater than the returned value. // It should be ignored because sequence actually exists in the db. if(validationException.getErrorCode() == ValidationException.SEQUENCE_SETUP_INCORRECTLY) { return true; } else { throw validationException; } } finally { if(!isConnected) { sequence.onDisconnect(session.getPlatform()); } } } /** * INTERNAL: * Indicates whether alterIncrement is supported */ public boolean isAlterSupported(AbstractSession session) { return session.getPlatform().isAlterSequenceObjectSupported(); } /** * INTERNAL: * Execute the SQL required to alter sequence increment. * Assume that the sequence exists. */ public void alterOnDatabase(AbstractSession session) throws TopLinkException { try { session.executeNonSelectingCall(new oracle.toplink.essentials.queryframework.SQLCall(buildAlterIncrementWriter(session, new StringWriter()).toString())); } catch (DatabaseException exception) { createOnDatabase(session); } } /** * INTERNAL: * Execute the SQL required to alter sequence increment. * Assume that the sequence exists. */ public void alterIncrement(AbstractSession session, Writer schemaWriter) throws ValidationException { if (schemaWriter == null) { this.alterOnDatabase(session); } else { this.buildAlterIncrementWriter(session, schemaWriter); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy