gov.nasa.pds.citool
Class CITool

java.lang.Object
  extended by gov.nasa.pds.citool.CITool
All Implemented Interfaces:
CIToolFlags, gov.nasa.pds.tools.flags.ToolsFlags

public class CITool
extends java.lang.Object
implements CIToolFlags

Front end class for the Catalog Ingestion Tool.

Author:
mcayanan, hyunlee

Field Summary
 
Fields inherited from interface gov.nasa.pds.citool.options.CIToolFlags
ALIAS, ALLREFS, DBNAME, DBPASS, DBSERVER, DBUSER, INCLUDES, LOCAL, MODE, TARGET, VERBOSE, WHATIS_ALIAS, WHATIS_ALLREFS, WHATIS_DBNAME, WHATIS_DBPASS, WHATIS_DBSERVER, WHATIS_DBUSER, WHATIS_INCLUDES, WHATIS_LOCAL, WHATIS_MODE, WHATIS_TARGET, WHATIS_VERBOSE
 
Fields inherited from interface gov.nasa.pds.tools.flags.ToolsFlags
ARGNAME, CONFIG, DICT, HELP, LONG, REPORT, SHORT, VERSION, WHATIS_CONFIG, WHATIS_DICT, WHATIS_HELP, WHATIS_REPORT, WHATIS_VERSION
 
Constructor Summary
CITool()
           
 
Method Summary
 void doComparison(Target source, Target target)
          Compare two targets.
 void doIngest(Target target)
          Ingest catalog file(s).
 void doQuery(org.apache.commons.cli.CommandLine commandLine)
          Query the CommandLine object to process the options that were selected.
 void doRI(java.util.List<gov.nasa.pds.tools.label.Label> catalogs, java.net.URL allrefs)
           
 java.util.List<gov.nasa.pds.tools.label.Label> doValidation(Target target, gov.nasa.pds.tools.dict.Dictionary dictionary)
           
 void findNewStandardValues(java.util.List<gov.nasa.pds.tools.label.Label> catalogs, gov.nasa.pds.tools.dict.Dictionary dictionary)
          Finds new standard values in the given set of label files.
static void main(java.lang.String[] argv)
           
 gov.nasa.pds.tools.dict.Dictionary parseDictionary(java.util.List<java.lang.String> dictionaries)
           
 org.apache.commons.cli.CommandLine parseLine(java.lang.String[] argv)
          Parses the CITool command-line.
 void showHelp()
          Show the CITool usage.
 void showVersion()
          Show the version and disclaimer notice.
 gov.nasa.pds.tools.label.Label validate(java.net.URL file, gov.nasa.pds.tools.dict.Dictionary dictionary)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CITool

public CITool()
Method Detail

parseLine

public org.apache.commons.cli.CommandLine parseLine(java.lang.String[] argv)
                                             throws ApplicationException
Parses the CITool command-line.

Parameters:
argv - arguments given on the command-line
Throws:
ApplicationException

doQuery

public void doQuery(org.apache.commons.cli.CommandLine commandLine)
             throws InvalidOptionException
Query the CommandLine object to process the options that were selected.

Parameters:
commandLine - The CommandLine object
Throws:
InvalidOptionException

showVersion

public void showVersion()
                 throws java.io.IOException
Show the version and disclaimer notice.

Throws:
java.io.IOException

showHelp

public void showHelp()
Show the CITool usage.


doComparison

public void doComparison(Target source,
                         Target target)
                  throws java.lang.Exception
Compare two targets.

Parameters:
source - Object representation of the source
target - Object representation of the target
Throws:
java.lang.Exception

doIngest

public void doIngest(Target target)
              throws java.lang.Exception
Ingest catalog file(s).

Parameters:
target - URL of the target (directory or file)
Throws:
java.lang.Exception

doRI

public void doRI(java.util.List<gov.nasa.pds.tools.label.Label> catalogs,
                 java.net.URL allrefs)

findNewStandardValues

public void findNewStandardValues(java.util.List<gov.nasa.pds.tools.label.Label> catalogs,
                                  gov.nasa.pds.tools.dict.Dictionary dictionary)
Finds new standard values in the given set of label files.

Parameters:
catalogs - A list of catalog files.
dictionary - A PDS data dictionary

validate

public gov.nasa.pds.tools.label.Label validate(java.net.URL file,
                                               gov.nasa.pds.tools.dict.Dictionary dictionary)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

doValidation

public java.util.List<gov.nasa.pds.tools.label.Label> doValidation(Target target,
                                                                   gov.nasa.pds.tools.dict.Dictionary dictionary)
                                                            throws java.lang.Exception
Throws:
java.lang.Exception

parseDictionary

public gov.nasa.pds.tools.dict.Dictionary parseDictionary(java.util.List<java.lang.String> dictionaries)

main

public static void main(java.lang.String[] argv)


Copyright © 2005-2010 Planetary Data System. All Rights Reserved.