org.coode.oppl.InCollectionConstraint Maven / Gradle / Ivy
/**
* Copyright (C) 2008, University of Manchester
*
* Modifications to the initial code base are copyright of their
* respective authors, or their employers as appropriate. Authorship
* of the modifications may be determined from the ChangeLog placed at
* the end of this file.
*
* This library 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 2.1 of the License, or (at your option) any later version.
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.coode.oppl;
import static org.coode.oppl.utils.ArgCheck.checkNotNull;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import org.coode.oppl.rendering.ManchesterSyntaxRenderer;
import org.semanticweb.owlapi.model.OWLObject;
import org.semanticweb.owlapi.util.ShortFormProvider;
/** Constraint that verifies whether a variable values are contained in a
* collection
*
* @author Luigi Iannone
* @param
* type */
public class InCollectionConstraint
implements AbstractConstraint {
private final Variable
variable;
private final Set
collection = new HashSet
();
private final ConstraintSystem constraintSystem;
/** @param variable
* variable
* @param collection
* collection
* @param constraintSystem
* constraintSystem */
public InCollectionConstraint(Variable
variable,
Collection collection, ConstraintSystem constraintSystem) {
if (collection.isEmpty()) {
throw new IllegalArgumentException("The collection of values cannot be empty");
}
this.variable = checkNotNull(variable, "variable");
this.collection.addAll(checkNotNull(collection, "collection"));
this.constraintSystem = checkNotNull(constraintSystem, "constraintSystem");
for (P p : collection) {
if (!variable.getType().isCompatibleWith(p)) {
ManchesterSyntaxRenderer manchesterSyntaxRenderer = constraintSystem
.getOPPLFactory().getManchesterSyntaxRenderer(constraintSystem);
p.accept(manchesterSyntaxRenderer);
throw new IllegalArgumentException(String.format(
"The value %s is incompatible with variable %s of type %s",
manchesterSyntaxRenderer, variable, variable.getType()));
}
}
}
@Override
public O accept(ConstraintVisitorEx visitor) {
return visitor.visit(this);
}
/** @return the variable */
public Variable getVariable() {
return this.variable;
}
/** @return the collection */
public Set
getCollection() {
return new HashSet
(this.collection);
}
@Override
public int hashCode() {
return 3 * this.variable.hashCode() * 5 * this.collection.hashCode();
}
@Override
public boolean equals(Object obj) {
boolean toReturn = false;
if (obj instanceof InCollectionConstraint) {
InCollectionConstraint toCompare = (InCollectionConstraint) obj;
toReturn = this.getVariable().equals(toCompare.variable)
&& this.collection.equals(toCompare.collection);
}
return toReturn;
}
@Override
public String toString() {
StringBuilder buffer = new StringBuilder();
buffer.append(this.variable.getName());
buffer.append(" IN {");
boolean first = true;
String comma;
for (P p : this.collection) {
ManchesterSyntaxRenderer manchesterSyntaxRenderer = this
.getConstraintSystem().getOPPLFactory()
.getManchesterSyntaxRenderer(this.getConstraintSystem());
comma = !first ? ", " : "";
first = false;
buffer.append(comma);
p.accept(manchesterSyntaxRenderer);
buffer.append(manchesterSyntaxRenderer.toString());
}
buffer.append('}');
return buffer.toString();
}
@Override
public String render(ShortFormProvider shortFormProvider) {
StringBuffer buffer = new StringBuffer();
buffer.append(this.variable.getName());
buffer.append(" IN {");
boolean first = true;
String comma;
for (P p : this.collection) {
comma = !first ? ", " : "";
first = false;
buffer.append(comma);
ManchesterSyntaxRenderer renderer = new ManchesterSyntaxRenderer(
shortFormProvider);
p.accept(renderer);
buffer.append(renderer.toString());
}
buffer.append('}');
return buffer.toString();
}
@Override
public String render(ConstraintSystem cs) {
StringBuffer buffer = new StringBuffer();
buffer.append(this.variable.getName());
buffer.append(" IN {");
boolean first = true;
String comma;
for (P p : this.collection) {
comma = !first ? ", " : "";
first = false;
buffer.append(comma);
ManchesterSyntaxRenderer renderer = cs.getOPPLFactory()
.getManchesterSyntaxRenderer(this.getConstraintSystem());
p.accept(renderer);
buffer.append(renderer.toString());
}
buffer.append('}');
return buffer.toString();
}
@Override
public void accept(ConstraintVisitor visitor) {
visitor.visitInCollectionConstraint(this);
}
/** @return the constraintSystem */
public ConstraintSystem getConstraintSystem() {
return this.constraintSystem;
}
/** @param variable
* variable
* @param collection
* collection
* @param constraintSystem
* constraintSystem
* @param
* variable type
* @return in collection constraint */
public static
InCollectionConstraint
getInCollectionConstraint(Variable variable,
Collection collection, ConstraintSystem constraintSystem) {
return new InCollectionConstraint(variable, collection, constraintSystem);
}
}