1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 package gov.nasa.pds.vtool.flags;
16
17 import gov.nasa.pds.tools.flags.ToolsFlags;
18
19 /***
20 * Contains command-line option flags available to VTool.
21 *
22 * @author mcayanan
23 *
24 */
25 public interface VToolFlags extends ToolsFlags {
26
27 public final static String ALIAS[] = {"a", "alias"};
28 public final static String FOLLOW[] = {"F", "no-follow"};
29 public final static String IGNOREDIR[] = {"D", "ignore-dir", "patterns"};
30 public final static String IGNOREFILE[] = {"X", "ignore-file", "patterns"};
31 public final static String INCLUDES[] = {"I", "include", "paths"};
32 public final static String LOCAL[] = {"L", "local"};
33 public final static String LOG[] = {"l", "log-file", "file (optional)"};
34 public final static String PARTIAL[] = {"f", "force"};
35 public final static String PROGRESS[] = {"p", "progress"};
36 public final static String REGEXP[] = {"e", "regexp", "patterns"};
37 public final static String RPTSTYLE[] = {"s", "report-style", "full|sum|min"};
38 public final static String TARGET[] = {"t", "target", "labels,URLs,dirs"};
39 public final static String VERBOSE[] = {"v", "verbose", "1|2|3"};
40
41 public final static String WHATIS_ALIAS = "Enables aliasing";
42
43 public final static String WHATIS_DICT = "Specify the Planetary Science"
44 + " Data Dictionary full file name/URL and any local"
45 + " dictionaries to include for validation. Separate"
46 + " each file name with a space.";
47
48 public final static String WHATIS_FOLLOW = "Do not follow or check for"
49 + " the existence of files referenced by"
50 + " pointer statements in a label.";
51
52 public final static String WHATIS_IGNOREDIR = "Specify directory patterns"
53 + " to ignore. Separate each with a space. Patterns should be"
54 + " surrounded by quotes."
55 + " (i.e. -D \"EXTRAS\" \"LABEL\" or -D \"EXTRAS LABEL\")";
56
57 public final static String WHATIS_IGNOREFILE = "Specify file patterns to"
58 + " ignore from validation. Separate each with a space. Patterns"
59 + " should be surrounded by quotes."
60 + " (i.e. -X \"*TAB\" \"*IMG\" or -X \"*TAB *IMG\")";
61
62 public final static String WHATIS_INCLUDES = "Specify the paths to look"
63 + " for files referenced by pointers in a label. Separate each"
64 + " with a space. Default is to always look at the same"
65 + " directory as the label.";
66
67 public final static String WHATIS_LOCAL = "Validate files only in the"
68 + " target directory rather than recursively traversing down"
69 + " the subdirectories.";
70
71 public final static String WHATIS_LOG = "Specify the file name for the"
72 + " machine-readable log. A file specification is optional. If"
73 + " no file name is given, then the log will be written to"
74 + " standard out.";
75
76 public final static String WHATIS_PARTIAL = "Force VTool to validate a"
77 + " label fragment.";
78
79 public final static String WHATIS_PROGRESS = "Enable progress reporting.";
80
81 public final static String WHATIS_REGEXP = "Specify file patterns to look"
82 + " for when validating a directory. Separate each with a space."
83 + " Patterns should be surrounded by quotes."
84 + " (i.e. -e \"*.LBL\" \"*.FMT\" or -e \"*.LBL *.FMT\")";
85
86 public final static String WHATIS_REPORT = "Specify the file name for the"
87 + " human-readable report. Default is to write to standard out if"
88 + " this flag is not specified. This report, however, will not"
89 + " print to standard out if this flag is missing AND the log file"
90 + " flag is specified with no file name.";
91
92 public final static String WHATIS_RPTSTYLE = "Specify the level of detail"
93 + " for the reporting. Valid values are 'full' for a full view,"
94 + " 'min' for a minimal view and 'sum' for a summary view."
95 + " Default is to see a full report if this flag is not"
96 + " specified.";
97
98 public final static String WHATIS_TARGET = "Explicitly specify the targets"
99 + " (label files, URLs and directories) to validate. Targets can"
100 + " be specified implicitly as well. (example: VTool label.lbl)";
101
102 public final static String WHATIS_VERBOSE = "Specify the severity level"
103 + " and above to include in the human-readable report:"
104 + " (1=Info, 2=Warning, 3=Error)."
105 + " Default is Warning and above (level 2).";
106 }