View Javadoc

1   package gov.nasa.pds.ltdt.gui.configuration;
2   
3   /***
4    * Contains keywords used in an LTDTool configuration file and
5    * when the MainWindow needs to find the values set during the
6    * execution run.
7    * 
8    * @author mcayanan
9    *
10   */
11  public interface LTDTKeys {
12  
13  	public final static String PROJDIRKEY = "ltdtool.project"; 
14  	public final static String DICTKEY = "ltdtool.dict";
15  	
16  	// Project related file names
17  	public final static String PROPERTYFILENAME = "property.lst";
18  	public final static String TEMPLATEFILENAME = "template.txt";
19  	public final static String WDDFILENAME      = "wdd.txt";
20  	public final static String PROJECTLOGNAME   = "project.log";
21  
22  	
23  	// LTDTool property file to track all projects 
24  	// (list of projects name registered with LTDT, and entry paths) 
25  	// This file goes to the user home directory called .ltdt
26  	public final static String HOMEDIR      = System.getProperty("user.home");
27  	public final static String LTDTPROPFILE = HOMEDIR+System.getProperty("file.separator")+".ltdt";
28  	
29  	public final static String PROJECTPROPERTYFILESUFFIX = System.getProperty("file.separator")+PROPERTYFILENAME;
30  	public final static String PROJECTTEMPLATESUFFIX = System.getProperty("file.separator")+TEMPLATEFILENAME;
31  	public final static String PROJECTWDDSUFFIX = System.getProperty("file.separator")+WDDFILENAME;
32  	public final static String PROJECTLOGFILESUFFIX = System.getProperty("file.separator")+PROJECTLOGNAME;
33  
34  	// Properties used by HELP displays
35  	public final static String TOOLNAME                = "ltdtool.name";
36  	public final static String TOOLVERSION             = "ltdtool.version";
37  	public final static String TOOLRELEASEDATE         = "ltdtool.date";
38  	public final static String TOOLCOPYRIGHT           = "ltdtool.copyright";
39  	
40  	// Properties to be kept for each project
41  	public final static String PROJECTNAME             = "project.name";
42  	public final static String PROJECTDIR              = "ltdtool.project" ;
43  	public final static String DICTIONARIES            = "project.dictionaries";
44  	public final static String TEMPLATEEXISTS          = "template.exists";
45  	public final static String WDDEXISTS               = "wdd.exists";
46  	public final static String TEMPLATETYPE            = "template.type";
47  	
48  	//  an array of properties used for project management
49  	public final String[] PROPERTYARRAY = {PROJECTNAME, PROJECTDIR, DICTIONARIES,
50  			TEMPLATEEXISTS, WDDEXISTS, TEMPLATETYPE};
51  	
52  	// known data types
53  	public final String[] SUPPORTEDTYPEARRAY = {
54  		    "INTEGER",
55  		    "CHARACTER",
56  		    "REAL",
57  		    "IDENTIFIER",
58  		    "TIME",
59  		    "DATE",
60  		    "CONTEXT_DEPENDENT",
61  		    "CONTEXTDEPENDENT",
62  		    "NONDECIMAL",
63  		    "NON_DECIMAL",
64  		    "DOUBLE",
65  		    "EXPONENTIAL",
66  		    "BIBLIO",
67  		    "ASCII_INTEGER",
68  		    "ALPHABET",
69  		    "ALPHANUMERIC",
70  		    "DATA_SET"
71  	};
72  	
73  	// data types that requires surrounding quotes
74  	public final String[] 	QUOTEDTYPEARRAY =  {
75  			"CHARACTER",
76  			"IDENTIFIER",
77  			"ALPHABET",
78  		    "ALPHANUMERIC",
79  		    "DATA_SET"
80  		    
81  	};
82  
83  	// Session level property	
84  	public final static String DICTIONARIESFROMCOMMAND = "commandline.dictionaries"; //dictionary path from cmd line delimited by ;
85  	public final static String PROJECTALTERED          = "project.altered";          //true if current project (named or untitled) was edited
86  	public final static String COMMANDLINEDICTIONARYADDED = "command.dic";           //true if -d specified at cmd line
87  
88  	// integer representation of definition type in data dictionary
89  	public final static int OBJECT_TYPE   = 1;
90  	public final static int ELEMENT_TYPE  = 2;
91  	public final static int GROUP_TYPE    = 3;
92  	public final static int ALL_TYPE      = 99;
93  	public final static int UNKNOWN_TYPE  = 0;
94  
95  	// WDD and data dictionary types
96  	public final String WDDSTATUSTYPE          = "WDD"; // during processing
97  	public final String WDDFINALSTATUSTYPE     = "PROPOSED"; // actually stored as
98  	public final String WDDDEFAULTSTANDARDVALUETYPE = "DYNAMIC";
99  	public final String WDDDEFAULTGENERALDATATYPE   = "CHARACTER";
100 	public final String WDDDEFAULTOBJECTTYPE        = "SPECIFIC";
101 	public final String DICTIONARYGENERICOBJECTTYPE = "GENERIC";
102 	public final String DICTIONARYSPECIFICOBJECTTYPE= "SPECIFIC";
103 	
104 	// general purpose status codes 	
105 	public final int SUCCESS = 0;
106 	public final int CANCELLED = -96;
107 	public final int WARNING = -97;
108 	public final int ERROR   = -98;
109 	public final int FAIL    = -99;
110 	
111 	
112 	//	status code related to -- tool open / project open   
113 	public final int PROJECTDIR_PROPERTY_FOUND    =  0; // found proj dir and a project map in it
114 	public final int NO_PROJECT_REGISTERED        = -1; // can not find any registered project
115 	public final int NO_PROJECTDIR_INFO           = -2; // proj dir info not provided
116 	public final int PROJECTDIR_NOT_FOUND         = -3; // proj dir location incorrect
117 	public final int FOUND_PROJECTDIR_NO_PROPERTY = -4; // proj dir found, but cannot find proj map
118 	public final int PROJECTDIR_NOT_READWRITEABLE = -5;
119 	public final int INVALID_DICTIONARY_NAME      = -6;
120 	public final int FOUND_PROJECTDIR_NO_PROPERTY_AND_NOT_READWRITEABLE = -7;
121 	
122 	// project creation related
123 	// creation types
124 	public final int NEWPROJECT = 1; // New project needed to save contents added to an untitled projecgt
125 	public final int SAVEAS = 2;     // copy content of a named project to a differnt location under a different name
126 	public final int NEWEMPTYPROJECT = 3; // New project without content
127 
128 	// window titles. This is not the full list, the ones listed below
129 	// are mostly titles of dialog or frames.
130 	public final String NEWPROJECTTITLE       = "Create New Project";
131 	public final String SAVEASTITLE           = "Save Project As";
132 	public final String UNTITLED              = "Untitled";
133 	public final String GENERICDEFINITIONTITLE = "Definition Details";
134 	public final String OBJECTDEFINITIONTITLE  = "Object Definition Details";
135 	public final String ELEMENTDEFINITIONTITLE = "Element Definition Details";
136 	public final String GROUPDEFINITIONTITLE   = "Group Definition Details";
137 	public final String ADDOBJECTTITLE         = "Add Dictionary Object";
138 	public final String ADDELEMENTTITLE        = "Add Dictionary Element";
139 	public final String MODIFYOBJECTTITLE      = "Modify Dictionary Object";
140 	public final String MODIFYELEMENTTITLE     = "Modify Dictionary Element";
141 	public final String PROJECTGALLERYTITLE    = "Project Gallery";
142 	public final String CREATEFROMTEMPLATETITLE= "New from Template";
143 	public final String CREATEFROMFILETITLE    = "New from File";
144 	public final String OPENPROJECTTITLE       = "Open Project";
145 	public final String PROJECTMODIFIEDTITLE   = "Project Modified";
146 
147 		
148 	// action commands 
149 	public final String OBJECTONLY            = "objectType";
150 	public final String ELEMENTONLY           = "elementType";
151 	public final String ALLTYPES              = "allTypes";
152 	public final String GETDICTIONARYFROMFILE = "getDDfromFile";
153 	public final String GETDICTIONARYFROMURL  = "getDDfromURL";
154 	public final String ADDOBJECT             = "addObject";
155 	public final String ADDELEMENT            = "addElement";
156 	public final String MODIFYOBJECT          = "modifyObject";
157 	public final String MODIFYELEMENT         = "modifyElement";
158 
159 	// data dictionary listing tab related 
160 	public final int NOSELECTEDINDEX          = -1;
161 	public final int OBJECTTABINDEX           = 0;
162 	public final int ELEMENTTABINDEX          = 1;
163 	public final int ALLTABINDEX              = 2;
164 	public final String OBJECTTABNAME         = "Object";
165 	public final String ELEMENTTABNAME        = "Element";
166 	public final String ALLTABNAME            = "Both";
167 	
168 	// project gallery tab related
169 	public final int NEWFROMTEMPLATETABINDEX   = 0;   
170 	public final int NEWFROMFILETABINDEX       = 1;
171 	public final int OPENPROJECTTABINDEX       = 2;
172 	public final String NEWFROMTEMPLATETABNAME = "Template";
173 	public final String NEWFROMFILETABNAME     = "File";
174 	public final String OPENPROJECTTABNAME     = "Open";
175 	
176 	// types of export
177 	public final int EXPORTTEMPLATE            = 1;
178 	public final int EXPORTWDD                 = 2;
179 	
180 	// misc
181 	public final String QUOTEDTYPESYMBOL       = "\"";
182 	public final String DICTIONARY_DELIMITER   = ";";
183 
184 	
185 }