]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/migration/MigrationStateKeys.java
New implementation NearestOwnerFinder of CommonDBUtils.getNearestOwner
[simantics/platform.git] / bundles / org.simantics.db.layer0 / src / org / simantics / db / layer0 / migration / MigrationStateKeys.java
1 /*******************************************************************************
2  * Copyright (c) 2012 Association for Decentralized Information Management in
3  * Industry THTH ry.
4  * All rights reserved. This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License v1.0
6  * which accompanies this distribution, and is available at
7  * http://www.eclipse.org/legal/epl-v10.html
8  *
9  * Contributors:
10  *     VTT Technical Research Centre of Finland - initial API and implementation
11  *******************************************************************************/
12 package org.simantics.db.layer0.migration;
13
14 import java.io.PrintWriter;
15
16 import org.eclipse.core.runtime.IProgressMonitor;
17 import org.simantics.db.Session;
18 import org.simantics.graph.db.ImportResult;
19
20 public interface MigrationStateKeys {
21
22     /**
23      * @see Session
24      */
25     public final static String SESSION = "session";
26     /**
27      * @see IProgressMonitor
28      */
29     public final static String PROGRESS_MONITOR = "progressMonitor";
30         public final static String BASE_URI = "baseURI";
31     public final static String MODEL_FILE = "modelFile";
32         public final static String CURRENT_TG = "currentTG";
33     public final static String CURRENT_TGS = "currentTGS";
34     
35     public final static String GET_RESOURCE_IDS = "getResourceIds";
36     public final static String RESOURCE_IDS = "resourceIds";
37
38     /**
39      * If this key is set, any messages logged by the migration process shall be
40      * written into the associated {@link PrintWriter} instance.
41      * 
42      * @see NullWriter
43      */
44     public final static String MESSAGE_LOG_WRITER = "messageLogWriter";
45
46     /**
47      * The reader used to support {@link #CURRENT_TGS}. Must be closed when
48      * state is disposed.
49      */
50     public final static String CURRENT_TGS_READER = "currentTGSReader";
51         public final static String CURRENT_DATA_CONTAINER = "currentDataContainer";
52         public final static String TG_EXTENSIONS = "tgExtensions";
53         public final static String CURRENT_RESOURCE = "currentResource";
54         public final static String IMPORT_ADVISOR = "importAdvisor";
55
56     /**
57      * Used for storing the {@link ImportResult} resulting from the TG import.
58      */
59     public final static String IMPORT_RESULT = "importResult";
60
61     /**
62      * All root resources of the imported material as
63      * Collection<Resource>.
64      */
65     public final static String CURRENT_ROOT_RESOURCES = "currentRootResources";
66     /**
67      * This is a hint that informs migration procedures whether they should
68      * disable dependency index updates in database requests they perform.
69      * Expects Boolean value and defaults to <code>true</code> if not defined.
70      */
71     public final static String UPDATE_DEPENDENCIES = "updateDependencies";
72
73     /**
74      * The database revision ID right after importing the transferable graph (
75      * {@link #CURRENT_TG} or {@link #CURRENT_TGS}) into the database which
76      * occurs when {@link #CURRENT_RESOURCE} or {@link #CURRENT_ROOT_RESOURCES}
77      * is asked for the first time.
78      */
79     public final static String DATABASE_REVISION_AFTER_TG_IMPORT = "revisionAfterTgImport";
80
81 }