CompletionService.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.cyclop.service.completion;

import javax.validation.constraints.NotNull;

import org.cyclop.model.ContextCqlCompletion;
import org.cyclop.model.CqlQuery;

/** @author Maciej Miklas */
public interface CompletionService {

	/**
	 * @return cql markers are: "alter table", "select" or "create keyspace" - columnType of cql query
	 */
	@NotNull
	ContextCqlCompletion findInitialCompletion();

	/**
	 * @param cursorPosition
	 *            starts from 0
	 */
	@NotNull
	ContextCqlCompletion findCompletion(@NotNull CqlQuery cqlQuery, int cursorPosition);

	@NotNull
	ContextCqlCompletion findCompletion(@NotNull CqlQuery cqlQuery);
}