com.intuit.ipp.query.OptionalSyntax Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ipp-v3-java-devkit Show documentation
IPP Java V3 DevKit Project - Core
The newest version!
/*******************************************************************************
 * Copyright (c) 2017 Intuit
 *
 * 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.intuit.ipp.query;

import com.intuit.ipp.query.expr.Expression;
import com.intuit.ipp.util.Logger;

/**
 * Class for optional syntax for the query message
 *
 */
public class OptionalSyntax {

	/**
	 * variable logger
	 */
	private static final org.slf4j.Logger LOG = Logger.getLogger();
	
	/**
	 * variable message
	 */
	private QueryMessage message = null;

	/**
	 * Constructor OptionalSyntax
	 * 
	 * @param mess the query message
	 */
	public OptionalSyntax(QueryMessage mess) {
		this.message = mess;
	}

	/**
	 * Method to get the optional syntax for where operator
	 * 
	 * @param expression the expression
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax where(Expression... expression) {
		for (Expression exp : expression) {
			getMessage().getOptional().add(exp.toString());
			LOG.debug("expression: " + exp);
		}
		QueryMessage mess = getMessage();
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the optional syntax for order by operator
	 * 
	 * @param Path the path
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax orderBy(Path... path) {
		String fieldList = "";
		boolean firstExpression = true;
		for (Path exp : path) {
			if (firstExpression) {
				fieldList = fieldList.concat(exp.toString());
				firstExpression = false;
			} else {
				fieldList = fieldList.concat(", ").concat(exp.toString());
			}

			LOG.debug("expression: " + exp);
		}
		QueryMessage mess = getMessage();
		mess.setOrderByClause(fieldList);
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the optional syntax for order by asc operator
	 * 
	 * @param Path the path
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax orderByAscending(Path... path) {
		String fieldList = "";
		boolean firstExpression = true;
		for (Path exp : path) {
			if (firstExpression) {
				fieldList = fieldList.concat(exp.toString());
				firstExpression = false;
			} else {
				fieldList = fieldList.concat(", ").concat(exp.toString());
			}

			LOG.debug("expression: " + exp);
		}

		fieldList = fieldList.concat(" ASC");
		QueryMessage mess = getMessage();
		mess.setOrderByClause(fieldList);
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the optional syntax for order by desc operator
	 * 
	 * @param Path the path
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax orderByDescending(Path... path) {
		String fieldList = "";
		boolean firstExpression = true;
		for (Path exp : path) {
			if (firstExpression) {
				fieldList = fieldList.concat(exp.toString());
				firstExpression = false;
			} else {
				fieldList = fieldList.concat(", ").concat(exp.toString());
			}

			LOG.debug("expression: " + exp);
		}

		fieldList = fieldList.concat(" DESC");
		QueryMessage mess = getMessage();
		mess.setOrderByClause(fieldList);
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the optional syntax for skip operator
	 * 
	 * @param num the number
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax skip(int num) {
		getMessage().setStartposition(num);
		QueryMessage mess = getMessage();
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the optional syntax for take operator
	 * 
	 * @param num the number
	 * @return OptionalSyntax the optional syntax
	 */
	public OptionalSyntax take(int num) {
		getMessage().setMaxresults(num);
		QueryMessage mess = getMessage();
		return new OptionalSyntax(mess);
	}

	/**
	 * Method to get the query message
	 * 
	 * @return QueryMessage teh query message
	 */
	public QueryMessage getMessage() {
		return message;
	}

	/**
	 * Method to set the query message
	 * 
	 * @param message the query message
	 */
	public void setMessage(QueryMessage message) {
		this.message = message;
	}

	/**
	 * Method to get the string value for the query message
	 * 
	 * @return string the query message
	 */
	public String generate() {
		return toString();
	}

	/**
	 * {@inheritDoc}}
	 */
	@Override
	public String toString() {
		return getMessage().toString();
	}
}