View Javadoc

1   // Copyright 2006-2007, by the California Institute of Technology.
2   // ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
3   // Any commercial use must be negotiated with the Office of Technology Transfer
4   // at the California Institute of Technology.
5   //
6   // This software is subject to U. S. export control laws and regulations
7   // (22 C.F.R. 120-130 and 15 C.F.R. 730-774). To the extent that the software
8   // is subject to U.S. export control laws and regulations, the recipient has
9   // the responsibility to obtain export licenses or other export authority as
10  // may be required before exporting such information to foreign countries or
11  // providing access to foreign nationals.
12  
13  // $Id$
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.";
46  	
47  	public final static String WHATIS_FOLLOW = "Do not follow or check for"
48  			+ " the existence of files referenced by" 
49  			+ " pointer statements in a label.";
50  	
51  	public final static String WHATIS_IGNOREDIR = "Specify directory patterns"
52  			+ " to ignore. Each pattern should be surrounded by quotes."
53  			+ " (i.e. -D \"EXTRAS\", \"LABEL\")";
54  
55  	public final static String WHATIS_IGNOREFILE = "Specify file patterns to"
56  			+ " ignore from validation. Each pattern should be surrounded by"
57  			+ " quotes."
58  			+ " (i.e. -X \"*TAB\", \"*IMG\")";
59  
60  	public final static String WHATIS_INCLUDES = "Specify the paths to look"
61  			+ " for files referenced by pointers in a label. Default is to"
62  			+ " always look at the same directory as the label.";
63  
64  	public final static String WHATIS_LOCAL = "Validate files only in the"
65  			+ " target directory rather than recursively traversing down"
66  			+ " the subdirectories.";
67  
68  	public final static String WHATIS_LOG = "Specify the file name for the"
69  			+ " machine-readable log. A file specification is optional. If"
70  			+ " no file name is given, then the log will be written to"
71  			+ " standard out.";
72  
73  	public final static String WHATIS_PARTIAL = "Force VTool to validate a"
74  			+ " label fragment.";
75  
76  	public final static String WHATIS_PROGRESS = "Enable progress reporting.";
77  	
78  	public final static String WHATIS_REGEXP = "Specify file patterns to look"
79  			+ " for when validating a directory. Each pattern should be"
80  			+ " surrounded by quotes."
81  			+ " (i.e. -e \"*.LBL\", \"*.FMT\")";
82  	
83  	public final static String WHATIS_REPORT = "Specify the file name for the"
84  			+ " human-readable report. Default is to write to standard out if"
85  			+ " this flag is not specified. This report, however, will not"
86  			+ " print to standard out if this flag is missing AND the log file"
87  			+ " flag is specified with no file name.";
88  
89  	public final static String WHATIS_RPTSTYLE = "Specify the level of detail"
90  			+ " for the reporting. Valid values are 'full' for a full view,"
91  			+ " 'min' for a minimal view and 'sum' for a summary view." 
92  			+ " Default is to see a full report if this flag is not"
93  			+ " specified.";
94  	
95  	public final static String WHATIS_TARGET = "Explicitly specify the targets"
96  			+ " (label files, URLs and directories) to validate. Targets can"
97  			+ " be specified implicitly as well. (example: VTool label.lbl)";
98  
99  	public final static String WHATIS_VERBOSE = "Specify the severity level"
100 			+ " and above to include in the human-readable report:"
101 			+ " (1=Info, 2=Warning, 3=Error)."
102 			+ " Default is Warning and above (level 2).";
103 }