You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oodt.apache.org by bf...@apache.org on 2011/10/13 20:46:41 UTC
svn commit: r1183023 - in /oodt/branches/cas-cl/src:
main/java/org/apache/oodt/cas/cl/
main/java/org/apache/oodt/cas/cl/help/formatter/
main/java/org/apache/oodt/cas/cl/help/presenter/
main/java/org/apache/oodt/cas/cl/help/printer/ main/java/org/apache...
Author: bfoster
Date: Thu Oct 13 18:46:41 2011
New Revision: 1183023
URL: http://svn.apache.org/viewvc?rev=1183023&view=rev
Log:
- Changed RequirementRule interface
- Simplified Help Printers
- Make everything more action driven
Added:
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java (contents, props changed)
- copied, changed from r1180819, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionSpecificHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java (contents, props changed)
- copied, changed from r1182632, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionSpecificHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java (contents, props changed)
- copied, changed from r1182632, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/ActionBasedRequirementRule.java
Removed:
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/formatter/
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionSpecificHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionSpecificHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/ActionBasedRequirementRule.java
Modified:
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/CmdLineUtility.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/CmdLineOptionHelpPresenter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/StdCmdLineOptionHelpPresenter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionHelpPrinter.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOption.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOptionInstance.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/GroupCmdLineOption.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/HelpCmdLineOption.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/SimpleCmdLineOption.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/RequirementRule.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/util/CmdLineOptionUtils.java
oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/parser/StdCmdLineOptionParser.java
oodt/branches/cas-cl/src/test/org/apache/oodt/cas/cl/option/util/TestCmdLineOptionUtils.java
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/CmdLineUtility.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/CmdLineUtility.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/CmdLineUtility.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/CmdLineUtility.java Thu Oct 13 18:46:41 2011
@@ -1,29 +1,35 @@
package org.apache.oodt.cas.cl;
-import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findSpecifiedHelpOption;
-import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.isHelpOption;
-import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.validateAndHandleInstances;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.determineRequired;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findActionOption;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findHelpOption;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findSpecifiedActionOption;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findSpecifiedOption;
import java.io.IOException;
+import java.util.HashSet;
import java.util.Set;
import org.apache.commons.lang.Validate;
-import org.apache.oodt.cas.cl.help.formatter.CmdLineOptionHelpFormatter;
-import org.apache.oodt.cas.cl.help.formatter.StdCmdLineOptionHelpFormatter;
+import org.apache.oodt.cas.cl.action.CmdLineAction;
import org.apache.oodt.cas.cl.help.presenter.CmdLineOptionHelpPresenter;
import org.apache.oodt.cas.cl.help.presenter.StdCmdLineOptionHelpPresenter;
+import org.apache.oodt.cas.cl.help.printer.CmdLineActionHelpPrinter;
import org.apache.oodt.cas.cl.help.printer.CmdLineOptionHelpPrinter;
-import org.apache.oodt.cas.cl.help.printer.CmdLineOptionSpecificHelpPrinter;
+import org.apache.oodt.cas.cl.help.printer.StdCmdLineActionHelpPrinter;
import org.apache.oodt.cas.cl.help.printer.StdCmdLineOptionHelpPrinter;
-import org.apache.oodt.cas.cl.help.printer.StdCmdLineOptionSpecificHelpPrinter;
import org.apache.oodt.cas.cl.option.ActionCmdLineOption;
import org.apache.oodt.cas.cl.option.CmdLineOption;
import org.apache.oodt.cas.cl.option.CmdLineOptionInstance;
-import org.apache.oodt.cas.cl.option.GroupCmdLineOption;
+import org.apache.oodt.cas.cl.option.HandleableCmdLineOption;
import org.apache.oodt.cas.cl.option.HelpCmdLineOption;
+import org.apache.oodt.cas.cl.option.ValidatableCmdLineOption;
+import org.apache.oodt.cas.cl.option.require.RequirementRule;
+import org.apache.oodt.cas.cl.option.require.RequirementRule.Relation;
import org.apache.oodt.cas.cl.option.store.CmdLineOptionStore;
import org.apache.oodt.cas.cl.option.store.spring.SpringCmdLineOptionStoreFactory;
import org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils;
+import org.apache.oodt.cas.cl.option.validator.CmdLineOptionValidator;
import org.apache.oodt.cas.cl.parser.CmdLineOptionParser;
import org.apache.oodt.cas.cl.parser.StdCmdLineOptionParser;
@@ -31,19 +37,15 @@ public class CmdLineUtility {
private CmdLineOptionParser parser;
private CmdLineOptionStore optionStore;
- private CmdLineOptionHelpPrinter helpPrinter;
- private CmdLineOptionSpecificHelpPrinter specificHelpPrinter;
- private CmdLineOptionHelpFormatter helpFormatter;
+ private CmdLineOptionHelpPrinter optionHelpPrinter;
+ private CmdLineActionHelpPrinter actionHelpPrinter;
private CmdLineOptionHelpPresenter helpPresenter;
- private boolean requireHelp;
- private boolean requireAction;
public CmdLineUtility() {
parser = new StdCmdLineOptionParser();
optionStore = new SpringCmdLineOptionStoreFactory().createStore();
- helpPrinter = new StdCmdLineOptionHelpPrinter();
- specificHelpPrinter = new StdCmdLineOptionSpecificHelpPrinter();
- helpFormatter = new StdCmdLineOptionHelpFormatter();
+ optionHelpPrinter = new StdCmdLineOptionHelpPrinter();
+ actionHelpPrinter = new StdCmdLineActionHelpPrinter();
helpPresenter = new StdCmdLineOptionHelpPresenter();
}
@@ -55,29 +57,20 @@ public class CmdLineUtility {
this.optionStore = optionStore;
}
- public CmdLineOptionHelpPrinter getHelpPrinter() {
- return helpPrinter;
+ public CmdLineOptionHelpPrinter getOptionHelpPrinter() {
+ return optionHelpPrinter;
}
- public void setHelpPrinter(CmdLineOptionHelpPrinter helpPrinter) {
- this.helpPrinter = helpPrinter;
+ public void setOptionHelpPrinter(CmdLineOptionHelpPrinter optionHelpPrinter) {
+ this.optionHelpPrinter = optionHelpPrinter;
}
- public CmdLineOptionSpecificHelpPrinter getSpecificHelpPrinter() {
- return specificHelpPrinter;
+ public CmdLineActionHelpPrinter getActionHelpPrinter() {
+ return actionHelpPrinter;
}
- public void setSpecificHelpPrinter(
- CmdLineOptionSpecificHelpPrinter specificHelpPrinter) {
- this.specificHelpPrinter = specificHelpPrinter;
- }
-
- public CmdLineOptionHelpFormatter getHelpFormatter() {
- return helpFormatter;
- }
-
- public void setHelpFormatter(CmdLineOptionHelpFormatter helpFormatter) {
- this.helpFormatter = helpFormatter;
+ public void setActionHelpPrinter(CmdLineActionHelpPrinter actionHelpPrinter) {
+ this.actionHelpPrinter = actionHelpPrinter;
}
public CmdLineOptionHelpPresenter getHelpPresenter() {
@@ -88,59 +81,146 @@ public class CmdLineUtility {
this.helpPresenter = helpPresenter;
}
- private void printHelp(Set<CmdLineOption> validOptions) {
- helpPresenter.presentHelp(helpFormatter.format(helpPrinter, validOptions));
+ public void printOptionHelp(Set<CmdLineOption> options) {
+ helpPresenter.presentOptionHelp(optionHelpPrinter.printHelp(options));
+ }
+
+ public void printActionHelp(CmdLineAction action, Set<CmdLineOption> options) {
+ helpPresenter.presentActionHelp(actionHelpPrinter.printHelp(action, options));
}
- private void printSpecificHelp(Set<CmdLineOption> validOptions, CmdLineOptionInstance specifiedOption) {
- helpPresenter.presentSpecificHelp(helpFormatter.format(
- specificHelpPrinter, validOptions, specifiedOption));
+ public void run(String[] args) throws IOException {
+ Set<CmdLineOptionInstance> specifiedOptions = parse(args);
+ if (!handleHelp(specifiedOptions)) {
+ execute(specifiedOptions);
+ }
}
- public void handleCmdLine(String[] args) throws IOException {
+ public Set<CmdLineOptionInstance> parse(String[] args) throws IOException {
Validate.notNull(parser);
Validate.notNull(optionStore);
// Load supported options.
Set<CmdLineOption> validOptions = optionStore.loadSupportedOptions();
- if (requireHelp) {
- ensureHasHelpOption(validOptions);
+
+ // Insure help options is present if required.
+ HelpCmdLineOption helpOption = findHelpOption(validOptions);
+ if (helpOption == null) {
+ validOptions.add(helpOption = new HelpCmdLineOption());
}
- if (requireAction) {
- ensureHasActionOption(validOptions);
+
+ // Insure action options is present if required.
+ ActionCmdLineOption actionOption = findActionOption(validOptions);
+ if (actionOption == null) {
+ validOptions.add(actionOption = new ActionCmdLineOption());
}
-
+
// Parse command line arguments.
- Set<CmdLineOptionInstance> specifiedOptions = parser.parse(args, validOptions);
+ return parser.parse(args, validOptions);
+ }
- // Check for help option and handle it if specified then return.
- GroupCmdLineOptionInstance helpOption = findSpecifiedHelpOption(specifiedOptions);
+ public boolean handleHelp(Set<CmdLineOptionInstance> specifiedOptions) throws IOException {
+ Set<CmdLineOption> supportedOptions = optionStore.loadSupportedOptions();
+ HelpCmdLineOption helpOption = findHelpOption(supportedOptions);
if (helpOption != null) {
- if (helpOption.getValues().isEmpty()) {
- printHelp(validOptions);
- } else {
- printSpecificHelp(validOptions, helpOption.getValues().get(0));
+ CmdLineOptionInstance specifiedHelpOption = findSpecifiedOption(
+ helpOption, specifiedOptions);
+ if (specifiedHelpOption != null) {
+ if (specifiedHelpOption.getSubOptions().isEmpty()) {
+ printOptionHelp(supportedOptions);
+ } else {
+ printActionHelp(getSelectedAction(specifiedOptions), supportedOptions);
+ }
+ return true;
}
- return;
}
+ return false;
+ }
- // Otherwise, validate and handle options.
- validateAndHandleInstances(validOptions, specifiedOptions);
+ public CmdLineAction getSelectedAction(Set<CmdLineOptionInstance> specifiedOptions) throws IOException {
+ CmdLineOptionInstance actionOption = findSpecifiedActionOption(specifiedOptions);
+ if (actionOption == null) {
+ throw new IOException("Action option not specified");
+ }
+ CmdLineAction action = findAction(actionOption, optionStore.loadSupportedActions());
+ if (action == null) {
+ throw new IOException("Action '" + actionOption + "' is not a supported action");
+ }
+ return action;
}
- private void ensureHasHelpOption(Set<CmdLineOption> options) {
- Validate.notNull(options);
+ public void execute(Set<CmdLineOptionInstance> specifiedOptions) throws IOException {
+ CmdLineAction action = getSelectedAction(specifiedOptions);
+
+ Set<CmdLineOption> requiredOptions = determineRequired(action, optionStore.loadSupportedOptions());
+ Set<CmdLineOption> requiredOptionsNotSet = check(requiredOptions, specifiedOptions);
+ if (!requiredOptionsNotSet.isEmpty()) {
+ throw new IOException("Required options are not set: '" + requiredOptionsNotSet + "'");
+ }
+
+ Set<CmdLineOptionInstance> optionsFailedValidation = validate(specifiedOptions);
+ if (!optionsFailedValidation.isEmpty()) {
+ throw new IOException("Options failed validation: '" + optionsFailedValidation + "'");
+ }
- if (CmdLineOptionUtils.findHelpOption(options) == null) {
- options.add(new HelpCmdLineOption());
+ handle(action, specifiedOptions);
+
+ action.execute();
+ }
+
+ public static Set<CmdLineOption> check(Set<CmdLineOption> requiredOptions, Set<CmdLineOptionInstance> specifiedOptions) {
+ HashSet<CmdLineOption> requiredOptionsNotSet = new HashSet<CmdLineOption>(requiredOptions);
+ for (CmdLineOptionInstance specifiedOption : specifiedOptions) {
+ requiredOptionsNotSet.remove(specifiedOption.getOption());
}
+ return requiredOptionsNotSet;
}
- private void ensureHasActionOption(Set<CmdLineOption> options) {
+ public static Set<CmdLineOptionInstance> validate(Set<CmdLineOptionInstance> options) {
Validate.notNull(options);
- if (CmdLineOptionUtils.findActionOption(options) == null) {
- options.add(new ActionCmdLineOption());
+ HashSet<CmdLineOptionInstance> optionsFailed = new HashSet<CmdLineOptionInstance>();
+ for (CmdLineOptionInstance optionInst : options) {
+ if (!validate(optionInst)) {
+ optionsFailed.add(optionInst);
+ }
+ }
+ return optionsFailed;
+ }
+
+ public static boolean validate(CmdLineOptionInstance option) {
+ if (option.isValidatable()) {
+ for (CmdLineOptionValidator validator : ((ValidatableCmdLineOption) option.getOption()).getValidators()) {
+ if (!validator.validate(option)) {
+ return false;
+ }
+ }
+ }
+ return true;
+ }
+
+ public static CmdLineAction findAction(CmdLineOptionInstance actionOption, Set<CmdLineAction> supportedActions) {
+ Validate.isTrue(actionOption.isAction());
+ Validate.notEmpty(actionOption.getValues());
+
+ String actionName = actionOption.getValues().get(0);
+ for (CmdLineAction action : supportedActions) {
+ if (action.getName().equals(actionName)) {
+ return action;
+ }
+ }
+ return null;
+ }
+
+ public static void handle(CmdLineAction action, Set<CmdLineOptionInstance> options) {
+ for (CmdLineOptionInstance option : options) {
+ handle(action, option);
+ }
+ }
+
+ public static void handle(CmdLineAction action, CmdLineOptionInstance option) {
+ if (option.isHandleable()) {
+ ((HandleableCmdLineOption) option.getOption()).getHandler().handleOption(action, option);
}
}
}
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/CmdLineOptionHelpPresenter.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/CmdLineOptionHelpPresenter.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/CmdLineOptionHelpPresenter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/CmdLineOptionHelpPresenter.java Thu Oct 13 18:46:41 2011
@@ -2,8 +2,8 @@ package org.apache.oodt.cas.cl.help.pres
public interface CmdLineOptionHelpPresenter {
- public void presentHelp(String helpMessage);
+ public void presentOptionHelp(String optionHelpMessage);
- public void presentSpecificHelp(String specificHelpMessage);
+ public void presentActionHelp(String actionHelpMessage);
}
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/StdCmdLineOptionHelpPresenter.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/StdCmdLineOptionHelpPresenter.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/StdCmdLineOptionHelpPresenter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/presenter/StdCmdLineOptionHelpPresenter.java Thu Oct 13 18:46:41 2011
@@ -10,12 +10,12 @@ public class StdCmdLineOptionHelpPresent
ps = new PrintStream(System.out);
}
- public void presentHelp(String helpMessage) {
- ps.println(helpMessage);
+ public void presentOptionHelp(String optionHelpMessage) {
+ ps.println(optionHelpMessage);
}
- public void presentSpecificHelp(String specificHelpMessage) {
- ps.println(specificHelpMessage);
+ public void presentActionHelp(String actionHelpMessage) {
+ ps.println(actionHelpMessage);
}
}
Copied: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java (from r1180819, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionSpecificHelpPrinter.java)
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java?p2=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java&p1=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionSpecificHelpPrinter.java&r1=1180819&r2=1183023&rev=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionSpecificHelpPrinter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java Thu Oct 13 18:46:41 2011
@@ -1,20 +1,12 @@
package org.apache.oodt.cas.cl.help.printer;
-import org.apache.oodt.cas.cl.option.CmdLineOption;
-import org.apache.oodt.cas.cl.option.CmdLineOptionInstance;
-
-public interface CmdLineOptionSpecificHelpPrinter {
-
- public String getHeader(CmdLineOptionInstance specifiedOption);
+import java.util.Set;
- public String getRequiredSubHeader(CmdLineOptionInstance specifiedOption);
-
- public String getRequiredOptionHelp(CmdLineOption option, CmdLineOptionInstance specifiedOption);
-
- public String getOptionalSubHeader(CmdLineOptionInstance specifiedOption);
+import org.apache.oodt.cas.cl.action.CmdLineAction;
+import org.apache.oodt.cas.cl.option.CmdLineOption;
- public String getOptionalOptionHelp(CmdLineOption option, CmdLineOptionInstance specifiedOption);
+public interface CmdLineActionHelpPrinter {
- public String getFooter(CmdLineOptionInstance specifiedOption);
+ public String printHelp(CmdLineAction action, Set<CmdLineOption> options);
}
Propchange: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineActionHelpPrinter.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionHelpPrinter.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionHelpPrinter.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionHelpPrinter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/CmdLineOptionHelpPrinter.java Thu Oct 13 18:46:41 2011
@@ -1,13 +1,11 @@
package org.apache.oodt.cas.cl.help.printer;
+import java.util.Set;
+
import org.apache.oodt.cas.cl.option.CmdLineOption;
public interface CmdLineOptionHelpPrinter {
- public String getHeader();
-
- public String getOptionHelp(CmdLineOption option);
-
- public String getFooter();
+ public String printHelp(Set<CmdLineOption> options);
}
Copied: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java (from r1182632, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionSpecificHelpPrinter.java)
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java?p2=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java&p1=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionSpecificHelpPrinter.java&r1=1182632&r2=1183023&rev=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionSpecificHelpPrinter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java Thu Oct 13 18:46:41 2011
@@ -1,41 +1,68 @@
package org.apache.oodt.cas.cl.help.printer;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.determineOptional;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.determineRequired;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.sortOptionsByRequiredStatus;
+
+import java.util.List;
+import java.util.Set;
+
+import org.apache.oodt.cas.cl.CmdLineUtility;
+import org.apache.oodt.cas.cl.action.CmdLineAction;
import org.apache.oodt.cas.cl.option.CmdLineOption;
import org.apache.oodt.cas.cl.option.CmdLineOptionInstance;
+import org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils;
+
+public class StdCmdLineActionHelpPrinter implements
+ CmdLineActionHelpPrinter {
+
+ public String printHelp(CmdLineAction action, Set<CmdLineOption> options) {
+ StringBuffer sb = new StringBuffer("");
+ sb.append(getHeader(action)).append("\n");
-public class StdCmdLineOptionSpecificHelpPrinter implements
- CmdLineOptionSpecificHelpPrinter {
+ sb.append(getRequiredSubHeader()).append("\n");
+ Set<CmdLineOption> requiredOptions = determineRequired(action, options);
+ List<CmdLineOption> sortedRequiredOptions = sortOptionsByRequiredStatus(requiredOptions);
+ for (CmdLineOption option : sortedRequiredOptions) {
+ sb.append(getRequiredOptionHelp(option)).append("\n");
+ }
+
+ sb.append(getOptionalSubHeader()).append("\n");
+ Set<CmdLineOption> optionalOptions = determineOptional(action, options);
+ List<CmdLineOption> sortedOptionalOptions = sortOptionsByRequiredStatus(optionalOptions);
+ for (CmdLineOption option : sortedOptionalOptions) {
+ sb.append(getOptionalOptionHelp(option)).append("\n");
+ }
+
+ sb.append(getFooter(action)).append("\n");
+ return sb.toString();
+ }
- public String getHeader(CmdLineOptionInstance specifiedOption) {
- return "Option Help when option '--"
- + specifiedOption.getOption().getLongOption()
- + "' is specified with values " + specifiedOption.getValues();
+ protected String getHeader(CmdLineAction action) {
+ return "Action Help for '" + action.getName() + "'";
}
- public String getRequiredSubHeader(CmdLineOptionInstance specifiedOption) {
+ protected String getRequiredSubHeader() {
return " - Required:";
}
- public String getRequiredOptionHelp(CmdLineOption option,
- CmdLineOptionInstance specifiedOption) {
- return getOptionHelp(option, specifiedOption);
+ protected String getRequiredOptionHelp(CmdLineOption option) {
+ return getOptionHelp(option);
}
- public String getOptionalSubHeader(CmdLineOptionInstance specifiedOption) {
+ protected String getOptionalSubHeader() {
return " - Optional:";
}
- public String getOptionalOptionHelp(CmdLineOption option,
- CmdLineOptionInstance specifiedOption) {
- return getOptionHelp(option, specifiedOption);
+ protected String getOptionalOptionHelp(CmdLineOption option) {
+ return getOptionHelp(option);
}
- public String getFooter(CmdLineOptionInstance specifiedOption) {
+ protected String getFooter(CmdLineAction action) {
return "";
}
- private String getOptionHelp(CmdLineOption option,
- CmdLineOptionInstance specifiedOption) {
+ protected String getOptionHelp(CmdLineOption option) {
return " -" + option.getShortOption() + " [--" + option.getLongOption()
+ "] "
+ (option.hasArgs() ? "<" + option.getArgsDescription() + ">" : "");
Propchange: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineActionHelpPrinter.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionHelpPrinter.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionHelpPrinter.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionHelpPrinter.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/help/printer/StdCmdLineOptionHelpPrinter.java Thu Oct 13 18:46:41 2011
@@ -1,6 +1,10 @@
package org.apache.oodt.cas.cl.help.printer;
import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.getFormattedString;
+import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.sortOptionsByRequiredStatus;
+
+import java.util.List;
+import java.util.Set;
import org.apache.commons.lang.StringUtils;
import org.apache.oodt.cas.cl.option.AdvancedCmdLineOption;
@@ -8,7 +12,18 @@ import org.apache.oodt.cas.cl.option.Cmd
public class StdCmdLineOptionHelpPrinter implements CmdLineOptionHelpPrinter {
- public String getHeader() {
+ public String printHelp(Set<CmdLineOption> options) {
+ StringBuffer sb = new StringBuffer("");
+ List<CmdLineOption> sortedOptions = sortOptionsByRequiredStatus(options);
+ sb.append(getHeader()).append("\n");
+ for (CmdLineOption option : sortedOptions) {
+ sb.append(getOptionHelp(option)).append("\n");
+ }
+ sb.append(getFooter()).append("\n");
+ return sb.toString();
+ }
+
+ protected String getHeader() {
StringBuffer sb = new StringBuffer("");
sb.append("-----------------------------------------------------------------------------------------------------------------\n");
sb.append("|" + StringUtils.rightPad(" Short", 7) + "|"
@@ -17,7 +32,7 @@ public class StdCmdLineOptionHelpPrinter
return sb.toString();
}
- public String getOptionHelp(CmdLineOption option) {
+ protected String getOptionHelp(CmdLineOption option) {
String argName = option.hasArgs() ? " <" + option.getArgsDescription() + ">" : "";
String optionUsage = "-"
+ StringUtils.rightPad(option.getShortOption() + ",", 7) + "--"
@@ -43,7 +58,7 @@ public class StdCmdLineOptionHelpPrinter
return optionUsage;
}
- public String getFooter() {
+ protected String getFooter() {
return "-----------------------------------------------------------------------------------------------------------------";
}
}
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOption.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOption.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOption.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOption.java Thu Oct 13 18:46:41 2011
@@ -27,7 +27,7 @@ import org.apache.oodt.cas.cl.option.req
* @author bfoster
* @version $Revision$
*/
-public interface CmdLineOption extends Comparable<CmdLineOption> {
+public interface CmdLineOption {
public void setLongOption(String longOption);
@@ -61,8 +61,6 @@ public interface CmdLineOption extends C
public List<RequirementRule> getRequirementRules();
- public int compareTo(CmdLineOption cmdLineOption);
-
public boolean equals(Object obj);
public int hashCode();
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOptionInstance.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOptionInstance.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOptionInstance.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/CmdLineOptionInstance.java Thu Oct 13 18:46:41 2011
@@ -66,6 +66,14 @@ public class CmdLineOptionInstance {
return option instanceof HelpCmdLineOption;
}
+ public boolean isValidatable() {
+ return option instanceof ValidatableCmdLineOption;
+ }
+
+ public boolean isHandleable() {
+ return option instanceof HandleableCmdLineOption;
+ }
+
public void setValues(List<String> values) {
Validate.notNull(values);
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/GroupCmdLineOption.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/GroupCmdLineOption.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/GroupCmdLineOption.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/GroupCmdLineOption.java Thu Oct 13 18:46:41 2011
@@ -1,14 +1,20 @@
package org.apache.oodt.cas.cl.option;
+import java.util.HashSet;
import java.util.Set;
+import org.apache.commons.lang.Validate;
+
public class GroupCmdLineOption extends SimpleCmdLineOption {
private Set<SubOption> subOptions;
+ private boolean allowAnySubOption;
public GroupCmdLineOption() {
super();
this.setHasArgs(false);
+ this.setAllowAnySubOptions(false);
+ subOptions = new HashSet<SubOption>();
}
public GroupCmdLineOption(String shortOption, String longOption,
@@ -16,8 +22,24 @@ public class GroupCmdLineOption extends
super(shortOption, longOption, description, hasArgs);
}
+ public void setAllowAnySubOptions(boolean allowAnySubOption) {
+ this.allowAnySubOption = allowAnySubOption;
+ }
+
+ public boolean isAllowAnySubOptions() {
+ return subOptions.isEmpty() && allowAnySubOption;
+ }
+
public void setSubOptions(Set<SubOption> subOptions) {
- this.subOptions = subOptions;
+ Validate.notNull(subOptions, "Cannot set subOptions to NULL");
+
+ this.subOptions = new HashSet<SubOption>(subOptions);
+ }
+
+ public void addSubOption(SubOption subOption) {
+ Validate.notNull(subOption, "Cannot add NULL subOption");
+
+ subOptions.add(subOption);
}
public Set<SubOption> getSubOptions() {
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/HelpCmdLineOption.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/HelpCmdLineOption.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/HelpCmdLineOption.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/HelpCmdLineOption.java Thu Oct 13 18:46:41 2011
@@ -1,6 +1,6 @@
package org.apache.oodt.cas.cl.option;
-public class HelpCmdLineOption extends GroupCmdLineOption {
+public class HelpCmdLineOption extends SimpleCmdLineOption {
public HelpCmdLineOption() {
this("h", "help", "Prints help menu", false);
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/SimpleCmdLineOption.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/SimpleCmdLineOption.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/SimpleCmdLineOption.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/SimpleCmdLineOption.java Thu Oct 13 18:46:41 2011
@@ -139,14 +139,6 @@ public class SimpleCmdLineOption impleme
this.performAndQuit = performAndQuit;
}
- public int compareTo(CmdLineOption cmdLineOption) {
- int thisScore = (this.required ? 2 : 0)
- + (!requirementRules.isEmpty() ? 1 : 0);
- int compareScore = (cmdLineOption.isRequired() ? 2 : 0)
- + (!cmdLineOption.getRequirementRules().isEmpty() ? 1 : 0);
- return new Integer(thisScore).compareTo(compareScore);
- }
-
@Override
public boolean equals(Object obj) {
if (obj instanceof CmdLineOption) {
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/RequirementRule.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/RequirementRule.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/RequirementRule.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/RequirementRule.java Thu Oct 13 18:46:41 2011
@@ -25,6 +25,8 @@ import org.apache.oodt.cas.cl.action.Cmd
*/
public interface RequirementRule {
- public boolean isRequired(CmdLineAction selectedAction);
+ public enum Relation { REQUIRED, OPTIONAL, NONE }
+
+ public Relation getRelation(CmdLineAction action);
}
Copied: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java (from r1182632, oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/ActionBasedRequirementRule.java)
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java?p2=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java&p1=oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/ActionBasedRequirementRule.java&r1=1182632&r2=1183023&rev=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/ActionBasedRequirementRule.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java Thu Oct 13 18:46:41 2011
@@ -1,24 +1,91 @@
package org.apache.oodt.cas.cl.option.require;
-import java.util.HashSet;
import java.util.Set;
import org.apache.oodt.cas.cl.action.CmdLineAction;
-public class ActionBasedRequirementRule implements RequirementRule {
+public class StdRequirementRule implements RequirementRule {
- private Set<String> actionNames;
+ private Set<ActionDependency> dependencies;
- public void setActions(Set<String> actionNames) {
- this.actionNames = new HashSet<String>(actionNames);
+ public void setActionDependency(Set<ActionDependency> dependencies) {
+ this.dependencies = dependencies;
}
- public Set<String> getActions() {
- return actionNames;
+ public Set<ActionDependency> getActionDependency() {
+ return dependencies;
}
- public boolean isRequired(CmdLineAction selectedAction) {
- return actionNames.contains(selectedAction.getName());
+ public Relation getRelation(CmdLineAction action) {
+ for (ActionDependency dependency : dependencies) {
+ if (dependency.getActionName().equals(action.getName())) {
+ return dependency.getRelation();
+ }
+ }
+ return Relation.NONE;
}
+ public class ActionDependency {
+ String actionName;
+ Relation relation;
+
+ public ActionDependency() {}
+
+ public ActionDependency(String actionName, Relation relation) {
+ this.actionName = actionName;
+ this.relation = relation;
+ }
+
+ public String getActionName() {
+ return actionName;
+ }
+
+ public void setActionName(String actionName) {
+ this.actionName = actionName;
+ }
+
+ public Relation getRelation() {
+ return relation;
+ }
+
+ public void setRelation(Relation relation) {
+ this.relation = relation;
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + getOuterType().hashCode();
+ result = prime * result
+ + ((actionName == null) ? 0 : actionName.hashCode());
+ result = prime * result + ((relation == null) ? 0 : relation.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj)
+ return true;
+ if (obj == null)
+ return false;
+ if (getClass() != obj.getClass())
+ return false;
+ ActionDependency other = (ActionDependency) obj;
+ if (!getOuterType().equals(other.getOuterType()))
+ return false;
+ if (actionName == null) {
+ if (other.actionName != null)
+ return false;
+ } else if (!actionName.equals(other.actionName))
+ return false;
+ if (relation != other.relation)
+ return false;
+ return true;
+ }
+
+ private StdRequirementRule getOuterType() {
+ return StdRequirementRule.this;
+ }
+ }
}
Propchange: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/require/StdRequirementRule.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/util/CmdLineOptionUtils.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/util/CmdLineOptionUtils.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/util/CmdLineOptionUtils.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/option/util/CmdLineOptionUtils.java Thu Oct 13 18:46:41 2011
@@ -18,9 +18,9 @@
package org.apache.oodt.cas.cl.option.util;
//JDK imports
-import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
+import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
@@ -33,19 +33,10 @@ import org.apache.oodt.cas.cl.option.Adv
import org.apache.oodt.cas.cl.option.CmdLineOption;
import org.apache.oodt.cas.cl.option.CmdLineOptionInstance;
import org.apache.oodt.cas.cl.option.GroupCmdLineOption;
-import org.apache.oodt.cas.cl.option.GroupCmdLineOptionInstance;
-import org.apache.oodt.cas.cl.option.HandleableCmdLineOption;
import org.apache.oodt.cas.cl.option.HelpCmdLineOption;
-import org.apache.oodt.cas.cl.option.ValidatableCmdLineOption;
-import org.apache.oodt.cas.cl.action.CmdLineAction;
-import org.apache.oodt.cas.cl.help.presenter.StdCmdLineOptionHelpPresenter;
-import org.apache.oodt.cas.cl.help.formatter.StdCmdLineOptionHelpFormatter;
-import org.apache.oodt.cas.cl.help.printer.StdCmdLineOptionHelpPrinter;
-import org.apache.oodt.cas.cl.help.printer.StdCmdLineOptionSpecificHelpPrinter;
import org.apache.oodt.cas.cl.option.require.RequirementRule;
-import org.apache.oodt.cas.cl.option.validator.CmdLineOptionValidator;
-import org.apache.oodt.cas.cl.parser.CmdLineOptionParser;
-import org.apache.oodt.cas.cl.parser.StdCmdLineOptionParser;
+import org.apache.oodt.cas.cl.option.require.RequirementRule.Relation;
+import org.apache.oodt.cas.cl.action.CmdLineAction;
/**
* @author bfoster
@@ -55,39 +46,7 @@ public class CmdLineOptionUtils {
private CmdLineOptionUtils() {}
-// public static <T> Set<CmdLineOption<?>> getOptionallyRequiredOptions(
-// Set<CmdLineOption<?>> options, CmdLineOptionInstance<T> specifiedOption) {
-// HashSet<CmdLineOption<?>> optionalOptions = new HashSet<CmdLineOption<?>>();
-// for (CmdLineOption<T> option : (Set<CmdLineOption<T>>)(Set<?>) options) {
-// if (isOptionallyRequiredOption(option, specifiedOption)) {
-// optionalOptions.add(option);
-// }
-// }
-// return optionalOptions;
-// }
-//
-// public static <T> boolean isOptionallyRequiredOption(CmdLineOption<T> option,
-// CmdLineAction selectedAction) {
-// if (!isConditionallyRequired(option, selectedAction)) {
-// if (option.hasHandler()) {
-// return option.getHandler().isInterested(selectedAction);
-// }
-// }
-// return false;
-// }
-
-// public static Set<CmdLineOption<?>> getConditionallyRequiredOptions(
-// Set<CmdLineOption<?>> options, CmdLineOptionInstance<?> specifiedOption) {
-// HashSet<CmdLineOption<?>> requiredOptions = new HashSet<CmdLineOption<?>>();
-// for (CmdLineOption<?> option : options) {
-// if (isConditionallyRequired(option, specifiedOption)) {
-// requiredOptions.add(option);
-// }
-// }
-// return requiredOptions;
-// }
-
- public static Set<CmdLineOption> getRequiredOptions(CmdLineAction action,
+ public static Set<CmdLineOption> determineRequired(CmdLineAction action,
Set<CmdLineOption> options) {
Set<CmdLineOption> requiredOptions = getRequiredOptions(options);
for (CmdLineOption option : options) {
@@ -103,7 +62,29 @@ public class CmdLineOptionUtils {
Validate.notNull(action);
for (RequirementRule requirementRule : option.getRequirementRules()) {
- if (requirementRule.isRequired(action)) {
+ if (requirementRule.getRelation(action) == Relation.REQUIRED) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ public static Set<CmdLineOption> determineOptional(CmdLineAction action, Set<CmdLineOption> options) {
+ Set<CmdLineOption> requiredOptions = getRequiredOptions(options);
+ for (CmdLineOption option : options) {
+ if (isOptional(action, option)) {
+ requiredOptions.add(option);
+ }
+ }
+ return requiredOptions;
+ }
+
+ public static boolean isOptional(CmdLineAction action, CmdLineOption option) {
+ Validate.notNull(option);
+ Validate.notNull(action);
+
+ for (RequirementRule requirementRule : option.getRequirementRules()) {
+ if (requirementRule.getRelation(action) == Relation.OPTIONAL) {
return true;
}
}
@@ -119,39 +100,19 @@ public class CmdLineOptionUtils {
}
return requiredOptions;
}
-//
-// public static Set<CmdLineOption<?>> getRequiredOptions(
-// Set<CmdLineOption<?>> supportedOptions,
-// Set<CmdLineOptionInstance<?>> specifiedOptions) {
-// Set<CmdLineOption<?>> reqOptions = getAlwaysRequiredOptions(supportedOptions);
-// reqOptions.addAll(getConditionallyRequiredOptions(supportedOptions,
-// specifiedOptions));
-// return reqOptions;
-// }
-
-// public static Set<CmdLineOption<?>> getRequiredOptionsNotSet(
-// Set<CmdLineOption<?>> supportedOptions, Set<CmdLineOptionInstance<?>> setOptions) {
-// return getOptionsNotSet(getRequiredOptions(supportedOptions, setOptions),
-// setOptions);
-// }
-
-// public static Set<CmdLineOption<?>> getOptionsNotSet(
-// Set<CmdLineOption<?>> expectedOptions, Set<CmdLineOptionInstance<?>> setOptions) {
-// HashSet<CmdLineOption<?>> nonSetRequiredOptions = new HashSet<CmdLineOption<?>>();
-// TOP:
-// for (CmdLineOption<?> reqOption : expectedOptions) {
-// for (CmdLineOptionInstance<?> optionInst : setOptions) {
-// if (reqOption.equals(optionInst.getOption()))
-// continue TOP;
-// }
-// nonSetRequiredOptions.add(reqOption);
-// }
-// return nonSetRequiredOptions;
-// }
- public static List<CmdLineOption> sortOptionsByRequiredStatus(Set<CmdLineOption> options) {
+ public static List<CmdLineOption> sortOptionsByRequiredStatus(
+ Set<CmdLineOption> options) {
ArrayList<CmdLineOption> optionsList = new ArrayList<CmdLineOption>(options);
- Collections.sort(optionsList);
+ Collections.sort(optionsList, new Comparator<CmdLineOption>() {
+ public int compare(CmdLineOption option1, CmdLineOption option2) {
+ int thisScore = (option1.isRequired() ? 2 : 0)
+ + (!option1.getRequirementRules().isEmpty() ? 1 : 0);
+ int compareScore = (option2.isRequired() ? 2 : 0)
+ + (!option2.getRequirementRules().isEmpty() ? 1 : 0);
+ return new Integer(thisScore).compareTo(compareScore);
+ }
+ });
Collections.reverse(optionsList);
return optionsList;
}
@@ -173,82 +134,6 @@ public class CmdLineOptionUtils {
return null;
}
- public static Set<CmdLineOptionInstance> parseArgs(Set<CmdLineOption> supportedOptions, String[] args) throws IOException {
- CmdLineOptionParser parser = new StdCmdLineOptionParser();
- return parser.parse(args, supportedOptions);
- }
-
- public static Set<CmdLineOptionInstance> validateOptions(Set<CmdLineOptionInstance> options) throws IOException {
- Validate.notNull(options);
-
- HashSet<CmdLineOptionInstance> optionsFailed = new HashSet<CmdLineOptionInstance>();
- for (CmdLineOptionInstance optionInst : options) {
- if (!validateOption(optionInst)) {
- optionsFailed.add(optionInst);
- }
- }
- return optionsFailed;
- }
-
- public static boolean validateOption(CmdLineOptionInstance option) {
- if (isValidatable(option.getOption())) {
- for (CmdLineOptionValidator validator : ((ValidatableCmdLineOption) option.getOption()).getValidators()) {
- if (!validator.validate(option)) {
- return false;
- }
- }
- }
- return true;
- }
-
- public static boolean isValidatable(CmdLineOption option) {
- return option instanceof ValidatableCmdLineOption;
- }
-
- public static void handleOptions(CmdLineAction action, Set<CmdLineOptionInstance> options) {
- for (CmdLineOptionInstance option : options) {
- handleOption(action, option);
- }
- }
-
- public static void handleOption(CmdLineAction action, CmdLineOptionInstance option) {
- if (isHandleable(option.getOption())) {
- ((HandleableCmdLineOption) option.getOption()).getHandler().handleOption(action, option);
- }
- }
-
- public static boolean isHandleable(CmdLineOption option) {
- return option instanceof HandleableCmdLineOption;
- }
-
- public static void validateAndHandleInstances(Set<CmdLineOption> supportedOptions,
- Set<CmdLineOptionInstance> specifiedOptions) throws IOException {
-
-
- // check that required args have been specified
- Set<CmdLineOption> requiredOptions = getRequiredOptions();
- Set<CmdLineOption> unsetReqOptions = getRequiredOptionsNotSet(supportedOptions, specifiedOptions);
- if (!unsetReqOptions.isEmpty()) {
- throw new IOException("Miss required options: " + sortOptionsByRequiredStatus(unsetReqOptions));
- }
-
- // validate options
- Set<CmdLineOptionInstance> optionsFailedVal = validateOptions(specifiedOptions);
- if (!optionsFailedVal.isEmpty()) {
- throw new IOException("Options failed validations: " + optionsFailedVal);
- }
-
- // Check for perform and quit options and handle them if specified then return.
- Set<CmdLineOptionInstance> performAndQuitOptions = findPerformAndQuitOptions(specifiedOptions);
- if (!performAndQuitOptions.isEmpty()) {
- handleOptions(performAndQuitOptions);
- return;
- }
-
- // if all looks good . . . handle options
- handleOptions(specifiedOptions);
- }
-
public static boolean isSubOption(CmdLineOptionInstance specifiedOption, CmdLineOption option) {
if (specifiedOption.isGroup()) {
for (GroupCmdLineOption.SubOption subOption : ((GroupCmdLineOption) specifiedOption.getOption()).getSubOptions()) {
@@ -300,6 +185,7 @@ public class CmdLineOptionUtils {
return (ActionCmdLineOption) option;
}
}
+ return null;
}
public static CmdLineOptionInstance findSpecifiedActionOption(Set<CmdLineOptionInstance> options) {
@@ -308,6 +194,7 @@ public class CmdLineOptionUtils {
return option;
}
}
+ return null;
}
public static boolean isHelpOption(CmdLineOption option) {
@@ -333,40 +220,6 @@ public class CmdLineOptionUtils {
return null;
}
- public static void printHelp(Set<CmdLineOption> options) {
- new StdCmdLineOptionHelpPresenter()
- .presentHelp(new StdCmdLineOptionHelpFormatter().format(
- new StdCmdLineOptionHelpPrinter(), options));
- }
-
- public static void printSpecificHelp(Set<CmdLineOption> options,
- CmdLineOptionInstance specifiedOption) {
- new StdCmdLineOptionHelpPresenter()
- .presentSpecificHelp(new StdCmdLineOptionHelpFormatter()
- .format(new StdCmdLineOptionSpecificHelpPrinter(), options,
- specifiedOption));
- }
-
-// public static <T> Iterable<CmdLineOption<T>> safeCast(Iterable<CmdLineOption<?>> options) {
-// return new GenericsSafeIterable<CmdLineOption<T>>(options);
-// }
-//
-// public static <T> List<T> iterableToList(Iterable<T> iterable) {
-// ArrayList<T> safeItems = new ArrayList<T>();
-// for (T item : iterable) {
-// safeItems.add(item);
-// }
-// return safeItems;
-// }
-//
-// public static <T> HashSet<T> iterableToSet(Iterable<T> iterable) {
-// HashSet<T> safeItems = new HashSet<T>();
-// for (T item : iterable) {
-// safeItems.add(item);
-// }
-// return safeItems;
-// }
-
public static String getFormattedString(String string, int startIndex,
int endIndex) {
StringBuffer outputString = new StringBuffer("");
Modified: oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/parser/StdCmdLineOptionParser.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/parser/StdCmdLineOptionParser.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/parser/StdCmdLineOptionParser.java (original)
+++ oodt/branches/cas-cl/src/main/java/org/apache/oodt/cas/cl/parser/StdCmdLineOptionParser.java Thu Oct 13 18:46:41 2011
@@ -16,11 +16,11 @@
*/
package org.apache.oodt.cas.cl.parser;
-//JDK imports
import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.findHelpOption;
import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.getOptionByName;
import static org.apache.oodt.cas.cl.option.util.CmdLineOptionUtils.isSubOption;
+//JDK imports
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
@@ -88,7 +88,7 @@ public class StdCmdLineOptionParser exte
// Push group as current group.
groupOptions.push(groupInstance);
- } else if (option.hasArgs()) {
+ } else if (option.hasArgs() || option.equals(helpOption)) {
List<String> values = getValues(args, option);
if (values.isEmpty()) {
throw new IOException("Option " + option
@@ -124,34 +124,13 @@ public class StdCmdLineOptionParser exte
private List<String> getValues(Args args, CmdLineOption option) {
List<String> values = new ArrayList<String>();
String nextValue = args.getCurrentArg();
- while (!isOption(nextValue)) {
+ while (nextValue != null && !isOption(nextValue)) {
values.add(nextValue);
+ nextValue = args.getCurrentArg();
}
return values;
}
-// private List<CmdLineOptionInstance<?>> findOptions(Args args,
-// Set<CmdLineSubOption> subOptions) {
-// HashSet<CmdLineOption<?>> allOptions = new HashSet<CmdLineOption<?>>();
-// HashSet<CmdLineOption<?>> requiredOptions = new HashSet<CmdLineOption<?>>();
-// for (CmdLineSubOption subOption : subOptions) {
-// allOptions.add(subOption.getOption());
-// if (subOption.isRequired()) {
-// requiredOptions.add(subOption.getOption());
-// }
-// }
-//
-// HashSet<CmdLineOption<?>> setOptions = new HashSet<CmdLineOption<?>>();
-// for (String arg : args) {
-// if (isOption(arg)) {
-// CmdLineOption<?> option = CmdLineOptionUtils.getOptionByName(
-// getOptionName(arg), allOptions);
-//
-// }
-// }
-// return null;
-// }
-
private static boolean isOption(String arg) {
return (arg.startsWith("-"));
}
@@ -165,15 +144,4 @@ public class StdCmdLineOptionParser exte
return null;
}
}
-
-// private CmdLineOption<?> getHelpOption(Set<CmdLineOption<?>> options) {
-// for (CmdLineOption<?> option : options) {
-// if (option instanceof GroupCmdLineOption) {
-// if (((GroupCmdLineOption) option).isHelp()) {
-// return option;
-// }
-// }
-// }
-// return null;
-// }
}
Modified: oodt/branches/cas-cl/src/test/org/apache/oodt/cas/cl/option/util/TestCmdLineOptionUtils.java
URL: http://svn.apache.org/viewvc/oodt/branches/cas-cl/src/test/org/apache/oodt/cas/cl/option/util/TestCmdLineOptionUtils.java?rev=1183023&r1=1183022&r2=1183023&view=diff
==============================================================================
--- oodt/branches/cas-cl/src/test/org/apache/oodt/cas/cl/option/util/TestCmdLineOptionUtils.java (original)
+++ oodt/branches/cas-cl/src/test/org/apache/oodt/cas/cl/option/util/TestCmdLineOptionUtils.java Thu Oct 13 18:46:41 2011
@@ -6,12 +6,9 @@ import java.util.Set;
import junit.framework.TestCase;
-import org.apache.oodt.cas.cl.option.BasicCmdLineOption;
-import org.apache.oodt.cas.cl.option.BasicCmdLineOptionInstance;
import org.apache.oodt.cas.cl.option.CmdLineOption;
import org.apache.oodt.cas.cl.option.CmdLineOptionInstance;
import org.apache.oodt.cas.cl.option.GroupCmdLineOption;
-import org.apache.oodt.cas.cl.option.GroupCmdLineOptionInstance;
import org.apache.oodt.cas.cl.option.require.RequirementRule;
public class TestCmdLineOptionUtils extends TestCase {