/**
* Copyright (C) 2001-2017 by RapidMiner and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapidminer.com
*
* This program is free software: you can redistribute it and/or modify it under the terms of the
* GNU Affero General Public License as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* This program 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
* Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License along with this program.
* If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.example;
import java.io.Serializable;
import java.util.LinkedList;
import java.util.List;
/**
* This class holds the example set relevant information about a table attribute, i.e. its role
* (either regular or special). If the described attribute is a special attribute, this class also
* contains the corresponding special attribute name.
*
* @author Ingo Mierswa
*/
public class AttributeRole implements Serializable, Cloneable {
private static final long serialVersionUID = -4855352048163007173L;
private boolean special = false;
private String specialName = null;
private Attribute attribute;
private transient List<Attributes> owners = new LinkedList<Attributes>();
public AttributeRole(Attribute attribute) {
this.attribute = attribute;
}
/** Clone constructor. */
private AttributeRole(AttributeRole other) {
this.attribute = (Attribute) other.attribute.clone();
this.special = other.special;
this.specialName = other.specialName;
}
public Object readResolve() {
if (owners == null) {
owners = new LinkedList<Attributes>();
}
return this;
}
/** Performs a deep clone of the special fields but only a shallow clone of the attribute. */
@Override
public Object clone() {
return new AttributeRole(this);
}
/**
* This method must not be called except by the {@link Attributes} to which this AttributeRole
* is added.
*/
protected void addOwner(Attributes attributes) {
this.owners.add(attributes);
}
/**
* This method must not be called except by the {@link Attributes} to which this AttributeRole
* is added.
*/
protected void removeOwner(Attributes attributes) {
this.owners.remove(attributes);
}
public Attribute getAttribute() {
return attribute;
}
public void setAttribute(Attribute attribute) {
this.attribute = attribute;
}
public boolean isSpecial() {
return special;
}
public String getSpecialName() {
return specialName;
}
public void setSpecial(String specialName) {
for (Attributes attributes : owners) {
attributes.rename(this, specialName);
}
this.specialName = specialName;
if (specialName != null) {
this.special = true;
} else {
this.special = false;
}
}
public void changeToRegular() {
setSpecial(null);
}
@Override
public String toString() {
if (isSpecial()) {
return specialName + " := " + attribute.getName();
} else {
return attribute.getName();
}
}
}