com.intuit.ipp.query.expr.EnumPath 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
There is a newer version: 6.5.0
/*******************************************************************************
 * 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.expr;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;

import com.intuit.ipp.query.Operation;
import com.intuit.ipp.query.Path;
import com.intuit.ipp.util.MessageUtils;

/**
 * Class to generate the query string for enum value
 *
 */
public class EnumPath extends Path> {

	/**
	 * Constructor EnumPath
	 * 
	 * @param path the path
	 * @param entity the entity
	 */
	public EnumPath(String path, String entity) {
		super(path, entity);
	}

	/**
	 * Method to construct the equals expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> eq(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.eq, valueString);
	}

	/**
	 * Method to construct the not equals expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> neq(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.neq, valueString);
	}

	/**
	 * Method to construct the less than expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> lt(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.lt, valueString);
	}

	/**
	 * Method to construct the less than or equals expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> lte(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.lte, valueString);
	}

	/**
	 * Method to construct the greater than expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> gt(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.gt, valueString);
	}

	/**
	 * Method to construct the greater than or equals expression for enum
	 * 
	 * @param value the enum
	 * @return Expression
	 */
	public Expression> gte(Enum value) {
		String valueString = "'" + EnumPath.getValue(value) + "'";
		return new Expression>(this, Operation.gte, valueString);
	}

	/**
	 * Method to construct the in expression for enum
	 * 
	 * @param value the enum array
	 * @return Expression
	 */
	public Expression> in(Enum[] value) {
		String listString = "";
		Boolean firstString = true;
		for (Enum v : value) {
			if (firstString) {
				listString = listString.concat("('").concat(EnumPath.getValue(v)).concat("'");
				firstString = false;
			} else {
				listString = listString.concat(", '").concat(EnumPath.getValue(v)).concat("'");
			}
		}
		listString = listString.concat(")");
		return new Expression>(this, Operation.in, listString);
	}

	/**
	 * Intuit data enumerations have a value property which should be used in queries instead of enum names.
	 * @param value The enumeration for which to get the query value.
	 * @return The query value based on the given enumeration.
	 */
	private static String getValue(Enum value){
		try{
			String methodName = validateClass(value) ? "value":"name";
			Method m = value.getClass().getDeclaredMethod(methodName);
			return (String) m.invoke(value);
		} catch (NoSuchMethodException ex){
		} catch (IllegalAccessException ex){
		} catch (InvocationTargetException ex){
		}
		return value.toString();
	}
	
	/**
	 * Validates if the Enum class is in the Intuit whitelisted list
	 * @param value
	 * @return
	 */
	private static boolean validateClass(Enum value) {
		List