From: <ku...@us...> - 2008-04-01 10:23:37
|
Revision: 745 http://dl-learner.svn.sourceforge.net/dl-learner/?rev=745&view=rev Author: kurzum Date: 2008-04-01 03:23:30 -0700 (Tue, 01 Apr 2008) Log Message: ----------- added function getUsage() to components for writing a better doc file. implemented it in some component, where I was sure. added some output to ConfigOptionScriptGenerator, respectively to ComponentManager Modified Paths: -------------- trunk/src/dl-learner/org/dllearner/algorithms/refexamples/ExampleBasedROLComponent.java trunk/src/dl-learner/org/dllearner/algorithms/refinement/ROLearner.java trunk/src/dl-learner/org/dllearner/core/ComponentManager.java trunk/src/dl-learner/org/dllearner/kb/KBFile.java trunk/src/dl-learner/org/dllearner/kb/OWLFile.java trunk/src/dl-learner/org/dllearner/kb/sparql/SparqlKnowledgeSource.java trunk/src/dl-learner/org/dllearner/learningproblems/PosNegDefinitionLP.java trunk/src/dl-learner/org/dllearner/learningproblems/PosNegInclusionLP.java trunk/src/dl-learner/org/dllearner/learningproblems/PosOnlyDefinitionLP.java trunk/src/dl-learner/org/dllearner/reasoning/DIGReasoner.java trunk/src/dl-learner/org/dllearner/reasoning/FastInstanceChecker.java trunk/src/dl-learner/org/dllearner/reasoning/FastRetrievalReasoner.java trunk/src/dl-learner/org/dllearner/reasoning/OWLAPIReasoner.java Modified: trunk/src/dl-learner/org/dllearner/algorithms/refexamples/ExampleBasedROLComponent.java =================================================================== --- trunk/src/dl-learner/org/dllearner/algorithms/refexamples/ExampleBasedROLComponent.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/algorithms/refexamples/ExampleBasedROLComponent.java 2008-04-01 10:23:30 UTC (rev 745) @@ -324,6 +324,10 @@ return "example driven refinement operator based learning algorithm"; } + public static String getUsage() { + return "algorithm = refexamples;"; + } + @Override public void start() { algorithm.start(); Modified: trunk/src/dl-learner/org/dllearner/algorithms/refinement/ROLearner.java =================================================================== --- trunk/src/dl-learner/org/dllearner/algorithms/refinement/ROLearner.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/algorithms/refinement/ROLearner.java 2008-04-01 10:23:30 UTC (rev 745) @@ -327,6 +327,10 @@ return "refinement operator based learning algorithm"; } + public static String getUsage() { + return "algorithm = refinement;"; + } + private int coveredNegativesOrTooWeak(Description concept) { if(posOnly) return posOnlyLearningProblem.coveredPseudoNegativeExamplesOrTooWeak(concept); Modified: trunk/src/dl-learner/org/dllearner/core/ComponentManager.java =================================================================== --- trunk/src/dl-learner/org/dllearner/core/ComponentManager.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/core/ComponentManager.java 2008-04-01 10:23:30 UTC (rev 745) @@ -421,10 +421,24 @@ private String getComponentConfigString(Class<? extends Component> component) { String componentDescription = "component: " + invokeStaticMethod(component,"getName") + " (" + component.getName() + ")"; String str = componentDescription + "\n"; + String usage =""; + + usage = invokeStaticMethod(component,"getUsage")+""; + + + if(usage.equals("null")) { + System.out.println("Component "+component.getName()+" needs Usage definition"); + } + else { + System.out.println(usage +" |in| "+ component.getName()); + } + for(int i=0; i<componentDescription.length(); i++) str += "="; str += "\n\n"; + str += "Usage:\n"+usage+"\n\n"; + for(ConfigOption<?> option : componentOptions.get(component)) { str += option.toString() + "\n"; } Modified: trunk/src/dl-learner/org/dllearner/kb/KBFile.java =================================================================== --- trunk/src/dl-learner/org/dllearner/kb/KBFile.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/kb/KBFile.java 2008-04-01 10:23:30 UTC (rev 745) @@ -82,6 +82,10 @@ public static String getName() { return "KB file"; } + + public static String getUsage() { + return "import(\"kbFileName.kb\");"; + } public static Collection<ConfigOption<?>> createConfigOptions() { Collection<ConfigOption<?>> options = new LinkedList<ConfigOption<?>>(); Modified: trunk/src/dl-learner/org/dllearner/kb/OWLFile.java =================================================================== --- trunk/src/dl-learner/org/dllearner/kb/OWLFile.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/kb/OWLFile.java 2008-04-01 10:23:30 UTC (rev 745) @@ -47,6 +47,11 @@ public static String getName() { return "OWL file"; } + + public static String getUsage() { + return "import(\"owlFileName.owl\");"; + } + public static Collection<ConfigOption<?>> createConfigOptions() { Collection<ConfigOption<?>> options = new LinkedList<ConfigOption<?>>(); Modified: trunk/src/dl-learner/org/dllearner/kb/sparql/SparqlKnowledgeSource.java =================================================================== --- trunk/src/dl-learner/org/dllearner/kb/sparql/SparqlKnowledgeSource.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/kb/sparql/SparqlKnowledgeSource.java 2008-04-01 10:23:30 UTC (rev 745) @@ -104,6 +104,9 @@ public static String getName() { return "SPARQL Endpoint"; } + public static String getUsage() { + return "Example: import(\"http://dbpedia.openlinksw.com:8890/sparql\",\"SPARQL\");"; + } private static Logger logger = Logger .getLogger(SparqlKnowledgeSource.class); Modified: trunk/src/dl-learner/org/dllearner/learningproblems/PosNegDefinitionLP.java =================================================================== --- trunk/src/dl-learner/org/dllearner/learningproblems/PosNegDefinitionLP.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/learningproblems/PosNegDefinitionLP.java 2008-04-01 10:23:30 UTC (rev 745) @@ -64,6 +64,10 @@ public static String getName() { return "two valued definition learning problem"; } + + public static String getUsage() { + return "problem = XXX DEFAULT"; + } public static Collection<ConfigOption<?>> createConfigOptions() { return PosNegLP.createConfigOptions(); Modified: trunk/src/dl-learner/org/dllearner/learningproblems/PosNegInclusionLP.java =================================================================== --- trunk/src/dl-learner/org/dllearner/learningproblems/PosNegInclusionLP.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/learningproblems/PosNegInclusionLP.java 2008-04-01 10:23:30 UTC (rev 745) @@ -76,6 +76,11 @@ return "inclusion learning problem"; } + public static String getUsage() { + return "problem = posNegInclusion;"; + } + + /* * (non-Javadoc) * Modified: trunk/src/dl-learner/org/dllearner/learningproblems/PosOnlyDefinitionLP.java =================================================================== --- trunk/src/dl-learner/org/dllearner/learningproblems/PosOnlyDefinitionLP.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/learningproblems/PosOnlyDefinitionLP.java 2008-04-01 10:23:30 UTC (rev 745) @@ -46,6 +46,10 @@ public static String getName() { return "positive only definition learning problem"; } + + public static String getUsage() { + return "problem = posOnlyDefinition;"; + } /* (non-Javadoc) * @see org.dllearner.core.Component#init() Modified: trunk/src/dl-learner/org/dllearner/reasoning/DIGReasoner.java =================================================================== --- trunk/src/dl-learner/org/dllearner/reasoning/DIGReasoner.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/reasoning/DIGReasoner.java 2008-04-01 10:23:30 UTC (rev 745) @@ -173,6 +173,10 @@ public static String getName() { return "DIG reasoner"; } + + public static String getUsage() { + return "reasoner = dig;"; + } public static Collection<ConfigOption<?>> createConfigOptions() { Collection<ConfigOption<?>> options = new LinkedList<ConfigOption<?>>(); Modified: trunk/src/dl-learner/org/dllearner/reasoning/FastInstanceChecker.java =================================================================== --- trunk/src/dl-learner/org/dllearner/reasoning/FastInstanceChecker.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/reasoning/FastInstanceChecker.java 2008-04-01 10:23:30 UTC (rev 745) @@ -133,6 +133,10 @@ return "fast instance checker"; } + public static String getUsage() { + return "reasoner = fastInstanceChecker;"; + } + /* * (non-Javadoc) * Modified: trunk/src/dl-learner/org/dllearner/reasoning/FastRetrievalReasoner.java =================================================================== --- trunk/src/dl-learner/org/dllearner/reasoning/FastRetrievalReasoner.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/reasoning/FastRetrievalReasoner.java 2008-04-01 10:23:30 UTC (rev 745) @@ -150,8 +150,12 @@ public static String getName() { return "fast retrieval reasoner"; - } + } + public static String getUsage() { + return "reasoner = XXX;"; + } + /* (non-Javadoc) * @see org.dllearner.core.Component#applyConfigEntry(org.dllearner.core.ConfigEntry) */ Modified: trunk/src/dl-learner/org/dllearner/reasoning/OWLAPIReasoner.java =================================================================== --- trunk/src/dl-learner/org/dllearner/reasoning/OWLAPIReasoner.java 2008-03-31 14:36:13 UTC (rev 744) +++ trunk/src/dl-learner/org/dllearner/reasoning/OWLAPIReasoner.java 2008-04-01 10:23:30 UTC (rev 745) @@ -158,6 +158,10 @@ return "OWL API reasoner"; } + public static String getUsage() { + return "reasoner = owlAPI;"; + } + public static Collection<ConfigOption<?>> createConfigOptions() { Collection<ConfigOption<?>> options = new LinkedList<ConfigOption<?>>(); StringConfigOption type = new StringConfigOption("reasonerType", "FaCT++ or Pellet", "pellet"); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |