com.github.helenusdriver.driver.CreateSchema Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright (C) 2015-2015 The Helenus Driver Project Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.helenusdriver.driver;
import java.util.Set;
import com.github.helenusdriver.driver.info.ClassInfo;
/**
* The CreateSchema interface provides support for a statement
* which will create all the required elements (i.e. keyspace, tables, indexes)
* to support the schema for a given POJO. It will take care of creating the
* required keyspace, tables, and indexes and will also insert any initial
* objects defined by the POJO.
*
* Note: As opposed to the {@link CreateSchemas} statement, this one is
* designed to create the specified pojo class schema; as such keyspace suffixes
* are actually registered in the where clause using the suffix name (a.k.a. the
* column name) and not the suffix type which is meant to organize suffixes
* across multiple pojo classes.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @param The type of POJO associated with this statement.
*
* @since 1.0
*/
public interface CreateSchema
extends Statement, SequenceableStatement {
/**
* {@inheritDoc}
*
* Note: This will not be a valid query string since this statement
* will be creating a keyspace and all defined tables and indexes for the POJO
* class. It will then be a representation of the query strings for the keyspace
* and each table and index creation similar to a "BATCH" statement.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#getQueryString()
*/
@Override
public String getQueryString();
/**
* Gets all POJO classes found for the associated POJO for which the schema
* will be created (this might include more than the just the POJO class if
* this one represents a root entity).
*
* @author paouelle
*
* @return the non-null set of all POJO classes found
*/
public Set> getObjectClasses();
/**
* Gets all POJO class informations found for the associated POJO for which
* the schema will be created (this might include more than the just the POJO
* class if this one represents a root entity).
*
* @author paouelle
*
* @return the non-null set of all POJO class infos found
*/
public Set> getClassInfos();
/**
* Sets the 'IF NOT EXISTS' option for this CREATE SCHEMA statement to be applied
* to the keyspace, tables, and indexes creation.
*
* A create with that option will not succeed unless the corresponding element
* does not exist at the time the creation is executing. The existence check
* and creations are done transactionally in the sense that if multiple clients
* attempt to create a given keyspace, table, or index with this option, then
* at most one may succeed.
*
* Please keep in mind that using this option has a non negligible performance
* impact and should be avoided when possible.
*
* @author paouelle
*
* @return this CREATE SCHEMA statement.
*/
public CreateSchema ifNotExists();
/**
* Adds a WHERE clause to this statement used to specify suffixes when required.
*
* This is a shorter/more readable version for {@code where().and(clauses)}.
*
* @author paouelle
*
* @param clause the clause to add
* @return the where clause of this query to which more clause can be added.
* @throws IllegalArgumentException if the clause doesn't reference a
* suffix key defined in the POJO
*/
public Where where(Clause clause);
/**
* Returns a WHERE in-construct for this statement without adding clause.
*
* @author paouelle
*
* @return the where clause of this query to which more clause can be added.
*/
public Where where();
/**
* The Where interface defines a WHERE clause for the CREATE
* SCHEMA statement which can be used to specify suffix keys used for the
* keyspace name.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @param The type of POJO associated with the statement.
*
* @since 1.0
*/
public interface Where
extends Statement, SequenceableStatement {
/**
* Adds the provided clause to this WHERE clause.
*
* @author paouelle
*
* @param clause the clause to add.
* @return this WHERE clause.
* @throws NullPointerException if clause is null
* @throws IllegalArgumentException if the clause doesn't reference a
* suffix key defined in the POJO
*/
public Where and(Clause clause);
}
}