oracle.toplink.essentials.tools.schemaframework.SequenceDefinition 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.tools.schemaframework;
import java.io.Writer;
import oracle.toplink.essentials.internal.sessions.AbstractSession;
import oracle.toplink.essentials.exceptions.*;
/**
*
* Purpose: Allow a generic way of creating sequences on the different platforms,
* and allow optional parameters to be specified.
*
*/
public abstract class SequenceDefinition extends DatabaseObjectDefinition {
public SequenceDefinition(String name) {
super();
this.name = name;
}
/**
* INTERAL:
* Verify whether the sequence exists.
*/
public abstract boolean checkIfExist(AbstractSession session) throws DatabaseException;
/**
* INTERNAL:
* Indicates whether alter is supported
*/
public boolean isAlterSupported() {
return false;
}
/**
* INTERNAL:
* By default does nothing.
*/
public void alterOnDatabase(AbstractSession session) throws TopLinkException {
}
/**
* INTERNAL:
* Execute the SQL required to alter sequence.
* By default does nothing.
*/
public void alter(AbstractSession session, Writer writer) throws ValidationException {
}
/**
* INTERNAL:
*/
public void createOnDatabase(AbstractSession session) throws TopLinkException {
if (checkIfExist(session)) {
alterOnDatabase(session);
} else {
super.createOnDatabase(session);
}
}
/**
* INTERNAL:
* Return a TableDefinition
*/
public TableDefinition buildTableDefinition() {
return null;
}
}