X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.browsing.ui.model%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fmodel%2Fnodetypes%2FNodeType.java;fp=bundles%2Forg.simantics.browsing.ui.model%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fmodel%2Fnodetypes%2FNodeType.java;h=9ee9eec4d9ce3a205d87fd1bd5d74fcafb044409;hb=969bd23cab98a79ca9101af33334000879fb60c5;hp=0000000000000000000000000000000000000000;hpb=866dba5cd5a3929bbeae85991796acb212338a08;p=simantics%2Fplatform.git diff --git a/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java new file mode 100644 index 000000000..9ee9eec4d --- /dev/null +++ b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java @@ -0,0 +1,76 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 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.browsing.ui.model.nodetypes; + +import java.util.Collection; + +import org.simantics.browsing.ui.BuiltinKeys; +import org.simantics.browsing.ui.NodeContext; +import org.simantics.browsing.ui.NodeContext.ConstantKey; +import org.simantics.db.ReadGraph; +import org.simantics.db.exception.DatabaseException; +import org.simantics.ui.selection.WorkbenchSelectionElement; + +/** + * Node type specifies the content type and role of the node in + * the model browser. + * @author Hannu Niemistö + */ +public interface NodeType { + + public static class TypeKey implements ConstantKey { + private TypeKey() {} + @Override + public String toString() { + return "TYPE"; + } + }; + public static final ConstantKey TYPE = new TypeKey(); + + public static final ConstantKey[] KEY_SEQUENCE = new ConstantKey[] { + BuiltinKeys.INPUT, + TYPE + }; + + public static final ConstantKey[] KEY_SEQUENCE_EXT = new ConstantKey[] { + BuiltinKeys.INPUT, + TYPE, + BuiltinKeys.UI_CONTEXT, + BuiltinKeys.BROWSE_CONTEXT, + BuiltinKeys.ACTION_BROWSE_CONTEXT + }; + + /** + * Creates a node context from the content. If the content is not + * suitable for this node type, returns null. This method cannot + * assume anything about the Java type of the content given as + * a parameter, but if it returns a node its content must be + * an instance of the Java class given by getContentType. + */ + NodeContext createNodeContext(ReadGraph graph, Object content) throws DatabaseException; + + /** + * Returns the expected Java type of the content. + */ + Class getContentType(); + + /** + * Tests if this node type inherits (or is equal to) given node type. + */ + boolean inherits(ReadGraph graph, NodeType superType) throws DatabaseException; + + Collection getSuper(ReadGraph g) throws DatabaseException; + + String toString(ReadGraph graph) throws DatabaseException; + + WorkbenchSelectionElement getWorkbenchSelectionElement(NodeContext context); +}