X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.mapping%2Fsrc%2Forg%2Fsimantics%2Fmapping%2Fconstraint%2Finstructions%2FIInstruction.java;fp=bundles%2Forg.simantics.mapping%2Fsrc%2Forg%2Fsimantics%2Fmapping%2Fconstraint%2Finstructions%2FIInstruction.java;h=4b923235e41c7252cbc5729f25f93cac555e9ac4;hb=969bd23cab98a79ca9101af33334000879fb60c5;hp=0000000000000000000000000000000000000000;hpb=866dba5cd5a3929bbeae85991796acb212338a08;p=simantics%2Fplatform.git diff --git a/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java b/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java new file mode 100644 index 000000000..4b923235e --- /dev/null +++ b/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java @@ -0,0 +1,63 @@ +/******************************************************************************* + * Copyright (c) 2007, 2010 Association for Decentralized Information Management + * in Industry THTH ry. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * VTT Technical Research Centre of Finland - initial API and implementation + *******************************************************************************/ +package org.simantics.mapping.constraint.instructions; + +import gnu.trove.map.hash.TIntIntHashMap; +import gnu.trove.set.hash.TIntHashSet; + +import org.simantics.db.ReadGraph; +import org.simantics.db.WriteGraph; +import org.simantics.db.exception.DatabaseException; +import org.simantics.mapping.IContextualModification; + +public interface IInstruction { + + public static final boolean DEBUG = false; + public static final boolean DEBUG_MODI = false; + public static final boolean DISABLE_MODI = false; // Disables modifications, if DEBUG_MODI is true + // just prints intended modifications + public static final String INDENTATION = " "; + + /** + * Return value for query that finds no bindings. + */ + public static final Object FAILURE = new Object(); + + /** + * + * @param state + * @return FAILURE, if query failed + * null, if query succeeded but there is only one possible binding + * something else, if query succeeded and there might be more than one binding + */ + Object query(ReadGraph g, Object[] bindings) throws DatabaseException; + + /** + * @param state + * @param continuation + * @return FAILURE, if there are no more results + * null, if this was the last result + * non-null, if there were one result and may be more + */ + Object next(ReadGraph g, Object[] bindings, Object continuation) throws DatabaseException; + + IContextualModification claim(ReadGraph g, Object[] bindings) throws DatabaseException; + void doClaim(WriteGraph g, Object[] bindings) throws DatabaseException; + IContextualModification deny(ReadGraph g, Object[] bindings) throws DatabaseException; + void doDeny(WriteGraph g, Object[] bindings) throws DatabaseException; + + void collectVariables(TIntHashSet reads, TIntHashSet writes); + void mapVariables(TIntIntHashMap map); + + void toString(StringBuilder b, int indent); + +}