+ * An INodeContext can be initialized to contain multiple constants accessible + * with {@link ConstantKey}s through {@link #getConstant(ConstantKey)}. + *
+ *+ * It is vital that every instance of INodeContext contains a constant with the + * {@link ConstantKey} {@link BuiltinKeys#INPUT}, since that data is used all + * over the graph explorer framework for resolving labelers, imager, decorators + * and others. + *
+ * + *+ * INodeContext must implement {@link #equals(Object)} and {@link #hashCode()} + * to enable the graph explorer to work properly. + *
+ * + * @see NodeContextBuilder + * @see NodeContextUtil + */ +public interface NodeContext extends IAdaptable { + + NodeContext[] NONE = new NodeContext[0]; + + /** + * A key interface used for querying constants from INodeContext. Create + * static instances of this interface to create re-usable keys. + * + *
+ * See {@link BuiltinKeys} for standard concrete keys used in the
+ * implementations
+ *
+ * @param
+ * These are always cleared (invalidated) or updated inside the query
+ * manager. The methods available in {@link NodeQueryManager} are the only
+ * methods within the query system that the query implementation can use. It
+ * cannot perform lazy evaluation.
+ *
+ * @see NodeQueryManager
+ * @see NodeQueryProcessor
+ */
+ public static abstract class QueryKey
+ * The difference between these queries and {@link QueryKey} queries is that
+ * these queries cannot do any further queries, which is already prohibited
+ * by the only available interface, {@link PrimitiveQueryUpdater}. Instead
+ * these queries can use the
+ * {@link PrimitiveQueryUpdater#scheduleReplace(NodeContext, PrimitiveQueryKey, T)}
+ * method to store concrete values within the query manager and possibly
+ * replace them later when lazy evaluation has completed. Replacing a lazily
+ * evaluated result will automatically invalidate all queries depending on
+ * this result, also causing the UI to respond to the changes.
+ *
+ * @see PrimitiveQueryUpdater
+ * @see PrimitiveQueryProcessor
+ */
+ public static abstract class PrimitiveQueryKey
+ * The extending class must implement the getKeyName() method to provide a
+ * human-readable name for the key that is used in the default
+ * {@link #toString()} implementation.
+ *
+ *
+ * This class uses the class object as the default processor identifier
+ * object (see {@link CacheKey#processorIdenfitier()}. This should work
+ * out-of-the-box for most cases and need not be customized.
+ */
+ public abstract static class ParametrizedPrimitiveQueryKey the assumed type of the parameter object
+ * @param index the index of the reqeusted parameter
+ * @return the parameter with the specified index
+ * @throws ClassCastException if the key stored in the node is does not
+ * match P.
+ * @throws ArrayIndexOutOfBoundsException if a parameter with the
+ * specified index is not availble.
+ */
+ @SuppressWarnings("unchecked")
+ public P getParameter(int index) {
+ return (P) parameters[index];
+ }
+
+ public abstract String getKeyName();
+
+ /**
+ * Calculates the hash value for this key. The default implementation is
+ * based on the hash of the actual key class and the hash of the
+ * parameters.
+ *
+ * @return the hash value
+ */
+ protected int hash() {
+ return getClass().hashCode() * 31 + Arrays.hashCode(parameters);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj)
+ return true;
+ if (obj == null)
+ return false;
+ if (getClass() != obj.getClass())
+ return false;
+ ParametrizedPrimitiveQueryKey o = (ParametrizedPrimitiveQueryKey) obj;
+ return Arrays.equals(parameters, o.parameters);
+ }
+
+ @Override
+ public int hashCode() {
+ return hash;
+ }
+ }
+
+}
null there was
+ * no value for the key
+ * @throws ClassCastException if the key stored in the node is does not
+ * match T. This should not happen.
+ */
+