com.github.helenusdriver.driver.Delete 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;
/**
* The Delete interface extends the functionality of Cassandra's
* {@link com.datastax.driver.core.querybuilder.Delete} class to provide
* support for POJOs.
*
* @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 Delete
extends Statement, BatchableStatement {
/**
* Adds a WHERE clause to this statement.
*
* This is a shorter/more readable version for {@code where().and(clause)}.
*
* @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 references a column
* not defined in the POJO
*/
public Where where(Clause clause);
/**
* Returns a Where statement for this query without adding clause.
*
* @author paouelle
*
* @return the where clause of this query to which more clause can be added.
*/
public Where where();
/**
* Adds a new options for this DELETE statement.
*
* @author paouelle
*
* @param using the option to add.
* @return the options of this DELETE statement.
*/
public Options using(Using using);
/**
* The Where interface defines WHERE clause for a DELETE statement.
*
* @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, BatchableStatement {
/**
* Adds the provided clause to this WHERE clause.
*
* @author paouelle
*
* @param clause the clause to add.
* @return this WHERE clause.
* @throws IllegalArgumentException if the clause references a column
* not defined in the POJO
*/
public Where and(Clause clause);
/**
* Adds an option to the DELETE statement this WHERE clause is part of.
*
* @author paouelle
*
* @param using the using clause to add.
* @return the options of the DELETE statement this WHERE clause is part of.
*/
public Options using(Using using);
}
/**
* The Options interface defines the options of a DELETE statement.
*
* @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 Options
extends Statement, BatchableStatement {
/**
* Adds the provided option.
*
* @author paouelle
*
* @param using a DELETE option.
* @return this {@code Options} object.
*/
public Options and(Using using);
/**
* Adds a where clause to the DELETE statement these options are part of.
*
* @author paouelle
*
* @param clause clause to add.
* @return the WHERE clause of the DELETE statement these options are part of.
* @throws IllegalArgumentException if the clause references a column
* not defined in the POJO
*/
public Where where(Clause clause);
}
/**
* The Builder interface defines an in-construction DELETE statement.
*
* @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 Builder {
/**
* Adds tables to delete from using the keyspace defined in the POJO.
*
* This flavor should be used when the POJO doesn't require suffixes to the
* keyspace name.
*
* @author paouelle
*
* @param tables the names of the tables to delete from
* @return a newly build DELETE statement that deletes from the specified
* tables
* @throws NullPointerException if tables is null
* @throws IllegalArgumentException if any of the tables or any of the
* referenced columns are not defined by the POJO
*/
public Delete from(String... tables);
/**
* Specifies to delete from all tables defined in the POJO using the
* keyspace defined in the POJO.
*
* This flavor should be used when the POJO doesn't require suffixes to the
* keyspace name.
*
* @author paouelle
*
* @return a newly build DELETE statement that deletes from all tables
* defined in the POJO
* @throws IllegalArgumentException if any of the referenced columns are not
* defined by the POJO
*/
public Delete fromAll();
}
/**
* The Selection interface defines a selection clause for an
* in-construction DELETE statement.
*
* @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 response from this statement.
*
* @since 1.0
*/
public interface Selection extends Builder {
/**
* Deletes all columns (i.e. "DELETE FROM ...")
*
* @author paouelle
*
* @return an in-build DELETE statement
* @throws IllegalStateException if some columns had already been selected
* for this builder.
*/
public Builder all();
/**
* Deletes the provided column.
*
* @author paouelle
*
* @param name the column name to select for deletion.
* @return this in-build DELETE Selection
* @throws NullPointerException if name is null
*/
public Selection column(String name);
/**
* Deletes the provided list element.
*
* @author paouelle
*
* @param columnName the name of the list column.
* @param idx the index of the element to delete.
* @return this in-build DELETE Selection
* @throws NullPointerException if columName is null
* @throws ArrayIndexOutOfBoundsException if idx is less than 0
*/
public Selection listElt(String columnName, int idx);
/**
* Deletes a map element given a key.
*
* @author paouelle
*
* @param columnName the name of the map column.
* @param key the key for the element to delete.
* @return this in-build DELETE Selection
* @throws NullPointerException if columName or key
* is null
*/
public Selection mapElt(String columnName, Object key);
}
}