org.sakaiproject.citation.api.CitationCollectionOrder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sakai-citations-api Show documentation
This project creates the general APIs used by the Sakai Citations Helper
There is a newer version: 23.3
/**
 * Copyright (c) 2003-2016 The Apereo Foundation
 *
 * Licensed under the Educational Community 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://opensource.org/licenses/ecl2
 *
 * 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 org.sakaiproject.citation.api;

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

/**
 * Created by nickwilson on 6/23/15.
 */
public class CitationCollectionOrder {

	private String collectionId;
	private String citationid;
	private int location;
	private SectionType sectiontype;
	private String value;
	private List children = new ArrayList();

	public enum SectionType {
		HEADING1, HEADING2, HEADING3, DESCRIPTION, CITATION
	}

	public CitationCollectionOrder() {
	}

	public CitationCollectionOrder(String collectionId, String citationid, int location, SectionType sectiontype, String value) {
		this.collectionId = collectionId;
		this.citationid = citationid;
		this.location = location;
		this.sectiontype = sectiontype;
		this.value = value;
	}

	public CitationCollectionOrder(String collectionId, int location, SectionType sectiontype, String value) {
		this.collectionId = collectionId;
		this.location = location;
		this.sectiontype = sectiontype;
		this.value = value;
	}

	public List getChildren() {
		return children;
	}

	public void setChildren(List children) {
		this.children = children;
	}

	public void addChild(CitationCollectionOrder citationCollectionOrder) {
		this.children.add(citationCollectionOrder);
	}

	public String getCitationid() {
		return citationid;
	}

	public void setCitationid(String citationid) {
		this.citationid = citationid;
	}

	public SectionType getSectiontype() {
		return sectiontype;
	}

	public void setSectiontype(SectionType sectiontype) {
		this.sectiontype = sectiontype;
	}

	public String getCollectionId() {
		return collectionId;
	}

	public void setCollectionId(String collectionId) {
		this.collectionId = collectionId;
	}

	public int getLocation() {
		return location;
	}

	public void setLocation(int location) {
		this.location = location;
	}

	public String getValue() {
		return value;
	}

	public void setValue(String value) {
		this.value = value;
	}

	public List flatten() {
		List flattenedCitationCollectionOrders = new ArrayList();
		flattenedCitationCollectionOrders.add(this);
		for (CitationCollectionOrder h2Child : this.getChildren()) {
			flattenedCitationCollectionOrders.add(h2Child);
			for (CitationCollectionOrder h3Child : h2Child.getChildren()) {
				flattenedCitationCollectionOrders.add(h3Child);
				for (CitationCollectionOrder nestedCitation : h3Child.getChildren()) {
					flattenedCitationCollectionOrders.add(nestedCitation);
				}
			}
		}
		return flattenedCitationCollectionOrders;
	}

	public boolean isCitation() {
		return getSectiontype().equals(CitationCollectionOrder.SectionType.CITATION);
	}

	public int getCountCitations() {
		int citationNo = 0;
		for (CitationCollectionOrder citationCollectionOrder : this.getChildren()) {
			if (citationCollectionOrder.isCitation()){
				citationNo++;
			}
			else {
				for (CitationCollectionOrder collectionOrder : citationCollectionOrder.getChildren()) {
					if (collectionOrder.isCitation()){
						citationNo++;
					}
					else {
						for (CitationCollectionOrder order : collectionOrder.getChildren()) {
							if (order.isCitation()){
								citationNo++;
							}
							else {
								for (CitationCollectionOrder o : order.getChildren()) {
									if (o.isCitation()){
										citationNo++;
									}
								}
							}
						}
					}
				}
			}
		}
		return citationNo;
	}

	public CitationCollectionOrder copy(String collectionId) {

		CitationCollectionOrder citationCollectionOrder = new CitationCollectionOrder();

		citationCollectionOrder.setCollectionId(collectionId);

		citationCollectionOrder.setChildren(this.getChildren());
		citationCollectionOrder.setCitationid(this.getCitationid());
		citationCollectionOrder.setLocation(this.getLocation());
		citationCollectionOrder.setSectiontype(this.getSectiontype());
		citationCollectionOrder.setValue(this.getValue());

		return citationCollectionOrder;
	}

	public CitationCollectionOrder copy(String collectionId, String citationId) {

		CitationCollectionOrder citationCollectionOrder = copy(collectionId);
		citationCollectionOrder.setCitationid(citationId);
		return citationCollectionOrder;
	}
}