bundles/org.simantics.objmap2/src/org/simantics/objmap/structural/IStructuralObject.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2012, 2013 Association for Decentralized Information Management in\r
   3  * Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.objmap.structural;\r
  13 \r
  14 import java.util.List;\r
  15 \r
  16 import org.simantics.db.Resource;\r
  17 \r
  18 /**\r
  19  * Interface for structurally mapped Java objects.\r
  20  * \r
  21  * @author Marko Luukkainen <marko.luukkainen@vtt.fi>\r
  22  *\r
  23  */\r
  24 public interface IStructuralObject {\r
  25         \r
  26         /**\r
  27          * Context of an object. \r
  28          * @return\r
  29          */\r
  30         public List<IStructuralObject> getContext();\r
  31 \r
  32         /**\r
  33          * Sets object's context. Used by ObjMap, don't touch. \r
  34          * @param object\r
  35          */\r
  36         public void setContext(List<IStructuralObject> object);\r
  37         \r
  38         /**\r
  39          * Return type resource for Structural instances. For other objects returns null.\r
  40          * @return\r
  41          */\r
  42         public Resource getType();\r
  43         \r
  44         /**\r
  45          * Sets object's type. Used by ObjMap, don't touch.\r
  46          * @param object\r
  47          */\r
  48         public void setType(Resource type);\r
  49 }\r