/*
 *   ________________________________________________________________________________________
 *   
 *   Y O O R E E K A
 *   A library for data mining, machine learning, soft computing, and mathematical analysis
 *   ________________________________________________________________________________________ 
 *    
 *   The Yooreeka project started with the code of the book "Algorithms of the Intelligent Web " 
 *   (Manning 2009). Although the term "Web" prevailed in the title, in essence, the algorithms 
 *   are valuable in any software application.
 *  
 *   Copyright (c) 2007-2009 Haralambos Marmanis & Dmitry Babenko
 *   Copyright (c) 2009-${year} Marmanis Group LLC and individual contributors as indicated by the @author tags.  
 * 
 *   Certain library functions depend on other Open Source software libraries, which are covered 
 *   by different license agreements. See the NOTICE file distributed with this work for additional 
 *   information regarding copyright ownership and licensing.
 * 
 *   Marmanis Group LLC licenses this file to You 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 org.yooreeka.algos.taxis.tree;

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

/**
 * This class allows us to associate type with the attribute.
 */
public class AttributeDefinition implements java.io.Serializable {

	private static final long serialVersionUID = -8446442452030956318L;

	/**
	 * Creates a copy of attribute definitions.
	 * 
	 * @param attrs
	 *            original list of attributes.
	 * @return new list.
	 */
	public static List<AttributeDefinition> copyAttributeDefs(
			List<AttributeDefinition> attrs) {
		return new ArrayList<AttributeDefinition>(attrs);
	}

	/**
	 * Removes attribute definition with specified name from the list.
	 * 
	 * @param attrName
	 *            attribute name to remove.
	 * @param attributes
	 *            list to remove from.
	 */
	public static void removeAttributeDef(String attrName,
			List<AttributeDefinition> attributes) {

		if (attrName != null) {
			for (int i = 0, n = attributes.size(); i < n; i++) {
				AttributeDefinition a = attributes.get(i);
				if (attrName.equalsIgnoreCase(a.getName())) {
					attributes.remove(i);
					break;
				}
			}
		}
	}

	/*
	 * Attribute name
	 */
	private String name;

	/*
	 * Attribute can be described as continuous (has numeric values) or discrete
	 * (has nominal/categorical values).
	 */
	private boolean isDiscrete;

	public AttributeDefinition(String name, boolean isDiscrete) {
		this.name = name;
		this.isDiscrete = isDiscrete;
	}

	public String getName() {
		return name;
	}

	public boolean isDiscrete() {
		return isDiscrete;
	}
}
