com.aoindustries.aoserv.client.reseller.CategoryTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation
Java client for the AOServ Platform.
There is a newer version: 1.92.0
/*
 * aoserv-client - Java client for the AOServ Platform.
 * Copyright (C) 2009, 2016, 2017, 2018, 2019, 2020  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client.reseller;

import com.aoindustries.aoserv.client.AOServConnector;
import com.aoindustries.aoserv.client.CachedTableIntegerKey;
import com.aoindustries.aoserv.client.schema.Table;
import com.aoindustries.aoserv.client.ticket.Ticket;
import com.aoindustries.util.tree.Node;
import com.aoindustries.util.tree.Tree;
import com.aoindustries.util.tree.TreeCopy;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * @see Category
 * @see Ticket
 *
 * @author  AO Industries, Inc.
 */
final public class CategoryTable extends CachedTableIntegerKey {

	CategoryTable(AOServConnector connector) {
		super(connector, Category.class);
	}

	private static final OrderBy[] defaultOrderBy = {
		new OrderBy(Category.COLUMN_PARENT_name, ASCENDING),
		new OrderBy(Category.COLUMN_NAME_name, ASCENDING)
	};
	@Override
	protected OrderBy[] getDefaultOrderBy() {
		return defaultOrderBy;
	}

	@Override
	public Category get(int pkey) throws IOException, SQLException {
		return getUniqueRow(Category.COLUMN_PKEY, pkey);
	}

	/**
	 * Gets the list of all top-level categories that have a null parent.
	 */
	public List getTopLevelCategories() throws IOException, SQLException {
		List cached=getRows();
		List matches=new ArrayList<>();
		int size=cached.size();
		for(int c=0;c getChildrenCategories(Category parent) throws IOException, SQLException {
		return getIndexedRows(Category.COLUMN_PARENT, parent.getPkey());
	}

	@Override
	public Table.TableID getTableID() {
		return Table.TableID.TICKET_CATEGORIES;
	}

	/**
	 * Gets the category with the provided parent and name.
	 * Parent may be {@code null} for top-level categories.
	 */
	public Category getTicketCategory(Category parent, String name) throws IOException, SQLException {
		if(parent==null) {
			// Search all top-level
			for(Category tc : getRows()) {
				if(tc.parent==-1 && tc.name.equals(name)) return tc;
			}
		} else {
			// Use indexing from above
			for(Category child : getChildrenCategories(parent)) {
				if(child.name.equals(name)) return child;
			}
		}
		return null;
	}

	/**
	 * Gets a ticket category given its dot-separated path or {@code null} if not found.
	 */
	public Category getTicketCategoryByDotPath(String dotPath) throws IOException, SQLException {
		for(Category category : getRows()) {
			if(category.getDotPath().equals(dotPath)) return category;
		}
		return null;
	}

	// 
	private final Tree tree = () -> {
		List topLevelCategories = getTopLevelCategories();
		int size = topLevelCategories.size();
		if(size==0) {
			return Collections.emptyList();
		} else if(size==1) {
			Node singleNode = new TicketCategoryTreeNode(topLevelCategories.get(0));
			return Collections.singletonList(singleNode);
		} else {
			List> rootNodes = new ArrayList<>(size);
			for(Category topLevelCategory : topLevelCategories) rootNodes.add(new TicketCategoryTreeNode(topLevelCategory));
			return Collections.unmodifiableList(rootNodes);
		}
	};

	static class TicketCategoryTreeNode implements Node {

		private final Category ticketCategory;

		TicketCategoryTreeNode(Category ticketCategory) {
			this.ticketCategory = ticketCategory;
		}

		@Override
		public List> getChildren() throws IOException, SQLException {
			// Look for any existing children
			List children = ticketCategory.getChildrenCategories();
			int size = children.size();
			if(size==0) {
				// Any empty is rendered as not allowed to have children
				return null;
			} else if(size==1) {
				Node singleNode = new TicketCategoryTreeNode(children.get(0));
				return Collections.singletonList(singleNode);
			} else {
				List> childNodes = new ArrayList<>(size);
				for(Category child : children) childNodes.add(new TicketCategoryTreeNode(child));
				return Collections.unmodifiableList(childNodes);
			}
		}

		@Override
		public Category getValue() {
			return ticketCategory;
		}
	}

	/**
	 * Gets a Tree view of all the accessible categories.
	 * All access to the tree read-through to the underlying storage
	 * and are thus subject to change at any time.  If you need a consistent
	 * snapshot of the tree, consider using TreeCopy.
	 *
	 * @see  TreeCopy
	 */
	public Tree getTree() {
		return tree;
	}
	// 
}