iot.jcypher.query.factories.clause.USING Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcypher Show documentation

Provides seamlessly integrated Java access to graph databases (Neo4J) at different levels of abstraction.

The newest version!

/************************************************************************
 * Copyright (c) 2014 IoT-Solutions e.U.
 * 
 * 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 iot.jcypher.query.factories.clause;

import iot.jcypher.query.api.APIObjectAccess;
import iot.jcypher.query.api.using.UFactory;
import iot.jcypher.query.api.using.UsingIndex;
import iot.jcypher.query.api.using.UsingScan;
import iot.jcypher.query.ast.ASTNode;
import iot.jcypher.query.ast.ClauseType;

/**
 * JCYPHER CLAUSE
 */
public class USING {

	/**
	 * JCYPHER
	 * set the name of the index to use
	 * e.g. USING.INDEX("Person")...
	 * 

	 */
	public static UsingIndex INDEX(String indexName) {
		UsingIndex ret = UFactory.index(indexName);
		ASTNode an = APIObjectAccess.getAstNode(ret);
		an.setClauseType(ClauseType.USING_INDEX);
		return ret;
	}
	
	/**
	 * JCYPHER
	 * set the label to be used in the label scan
	 * e.g. USING.LABEL_SCAN("German")...
	 * 

	 */
	public static UsingScan LABEL_SCAN(String labelName) {
		UsingScan ret = UFactory.onLabel(labelName);
		ASTNode an = APIObjectAccess.getAstNode(ret);
		an.setClauseType(ClauseType.USING_SCAN);
		return ret;
	}
}