com.versionone.apiclient.services.OrderBy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of VersionOne.SDK.Java.APIClient Show documentation

A library for custom Java development against the VersionOne Development Platform's REST API.

There is a newer version: 16.1.3

Show newest version

package com.versionone.apiclient.services;

import java.util.ArrayList;
import java.util.List;

import com.versionone.apiclient.interfaces.IAttributeDefinition;

/**
 * Order a query
 */
public class OrderBy
{
	/**
	 * Supported sort orders
	 */
	public enum Order
	{
		/**
		 * Low to High
		 */
		Ascending,
		/**
		 * High to Low
		 */
		Descending
	}

	List _terms = new ArrayList();

	public List getTerms() { return (List) java.util.Collections.unmodifiableCollection(_terms); }

	/**
	 * Set the attribute and order for major sort of returned data
	 * 
	 * @param attribdef - IAttributeDefinition
	 * @param order - Order
	 */
	public void majorSort(IAttributeDefinition attribdef, Order order)
	{
		remove(attribdef);
		_terms.add(0,new Term(attribdef, order));
	}

	/**
	 * Set the attribute and order for minor sort of returned data
	 * 
	 * @param attribdef - IAttributeDefinition
	 * @param order - Order
	 */
	public void minorSort(IAttributeDefinition attribdef, Order order)
	{
		remove(attribdef);
		_terms.add(new Term(attribdef, order));
	}

	/**
	 * Return the number of terms
	 * 
	 * @return int
	 */
	public int size() { return _terms.size(); }

	/**
	 * Get the sort token
	 * 
	 * @return String
	 */
	public String getToken() {
		return TextBuilder.join(_terms,",");
	}

	/**
	 * Get the string representation of the sort
	 */
	@Override
	public String toString() { return getToken(); }

	private void remove(IAttributeDefinition attribdef)
	{
		int index = indexOf(attribdef);
		if (index == -1)
			return;
		_terms.remove(index);
	}

	private int indexOf(IAttributeDefinition attribdef)
	{
		for (int i=0;i<_terms.size();i++)
			if(((OrderBy.Term)_terms.get(i)).getAttributeDefinition() == attribdef)
				return i;
		return -1;
	}


	class Term
	{
		private IAttributeDefinition AttributeDefinition;
		private OrderBy.Order Order;

		public IAttributeDefinition getAttributeDefinition() {return AttributeDefinition;}
		public OrderBy.Order getOrder() {return Order;}

		public Term(IAttributeDefinition attribdef, Order order)
		{
			AttributeDefinition = attribdef;
			Order = order;
		}

		public String getToken() {
			StringBuffer token = new StringBuffer();
			if(Order != OrderBy.Order.Ascending)
				token.append("-");
			token.append(AttributeDefinition.getToken());
			return token.toString();
		}

		@Override
		public String toString() { return getToken(); }
	}
}