From 6422e03e74055de8f871982a42650c2104ff783f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Euzenat?= <Jerome.Euzenat@inria.fr>
Date: Fri, 20 Nov 2015 23:16:46 +0000
Subject: [PATCH] - fixed all Javadoc "errors" (no copyrigt update, no code
change)
---
src/fr/inrialpes/exmo/align/cli/GenPlot.java | 6 ++++-
.../inrialpes/exmo/align/cli/GroupAggreg.java | 14 +++++-----
.../inrialpes/exmo/align/cli/GroupEval.java | 22 ++++++++--------
.../exmo/align/cli/TransformQuery.java | 2 +-
.../inrialpes/exmo/align/impl/BasicCell.java | 2 +-
.../exmo/align/impl/BasicOntologyNetwork.java | 3 +--
.../exmo/align/impl/BasicParameters.java | 8 +++---
.../exmo/align/impl/DistanceAlignment.java | 2 +-
.../inrialpes/exmo/align/impl/Extensible.java | 26 ++++++++++++++++---
.../inrialpes/exmo/align/impl/ObjectCell.java | 2 +-
.../exmo/align/impl/edoal/Linkkey.java | 2 +-
.../exmo/align/impl/edoal/LinkkeyBinding.java | 2 +-
.../exmo/align/impl/edoal/LinkkeyEquals.java | 2 +-
.../align/impl/edoal/LinkkeyIntersects.java | 2 +-
.../exmo/align/impl/eval/ExtPREvaluator.java | 12 ++++-----
.../align/impl/eval/ROCCurveEvaluator.java | 2 +-
.../renderer/GraphPatternRendererVisitor.java | 1 -
.../impl/renderer/JSONRendererVisitor.java | 2 +-
.../renderer/OWLAxiomsRendererVisitor.java | 2 +-
.../exmo/align/parser/SyntaxElement.java | 20 ++++++--------
.../align/parser/TypeCheckingVisitor.java | 2 +-
.../exmo/align/service/SQLCache.java | 2 +-
.../exmo/align/service/VolatilCache.java | 6 ++---
.../exmo/ontowrap/OntologyCache.java | 7 +++--
src/org/semanticweb/owl/align/Alignment.java | 18 ++++++++-----
25 files changed, 95 insertions(+), 74 deletions(-)
diff --git a/src/fr/inrialpes/exmo/align/cli/GenPlot.java b/src/fr/inrialpes/exmo/align/cli/GenPlot.java
index d6eb3e8d..43adf8d0 100644
--- a/src/fr/inrialpes/exmo/align/cli/GenPlot.java
+++ b/src/fr/inrialpes/exmo/align/cli/GenPlot.java
@@ -213,7 +213,7 @@ public class GenPlot extends CommonCLI {
/**
* Iterate on each subdirectory
- * Returns a vector[ each algo ] of vector [ each point ]
+ * @return a vector[ each algo ] of vector [ each point ]
* The points are computed by aggregating the values
* (and in the end computing the average)
*/
@@ -324,6 +324,8 @@ public class GenPlot extends CommonCLI {
/**
* This does average plus plot
*
+ * @param result the resulting plot
+ * @param writer in which the output is sent
*/
public void printPGFTex( Vector<Vector<Pair>> result, PrintWriter writer ){
int i = 0;
@@ -421,6 +423,8 @@ public class GenPlot extends CommonCLI {
/**
* This does average plus generate the call for Google Chart API
*
+ * @param result the resulting plot
+ * @param writer in which the output is sent
*/
public void printHTMLGGraph( Vector<Vector<Pair>> result, PrintWriter writer ){
writer.print("<img src=\"http://chart.apis.google.com/chart?");
diff --git a/src/fr/inrialpes/exmo/align/cli/GroupAggreg.java b/src/fr/inrialpes/exmo/align/cli/GroupAggreg.java
index 2f1210d6..69f627a9 100644
--- a/src/fr/inrialpes/exmo/align/cli/GroupAggreg.java
+++ b/src/fr/inrialpes/exmo/align/cli/GroupAggreg.java
@@ -74,13 +74,13 @@ import org.apache.commons.cli.ParseException;
*
* where the options are:
* <pre>
- * -l,--list <FILE> List of FILEs to be included in the results
+ * -l,--list <FILE> List of FILEs to be included in the results
* (required)
- * -m,--aggmethod <METHOD> Method to use for aggregating (min|max|avg|pool)
- * -P,--params <FILE> Read parameters from FILE
- * -T,--cutmethod <METHOD> Method to use for triming (hard|perc|prop|best|span)
- * -t,--threshold <DOUBLE> Trim the alignment with regard to threshold
- * -w,--workDir <DIR> The DIRectory containing the data to evaluate
+ * -m,--aggmethod <METHOD> Method to use for aggregating (min|max|avg|pool)
+ * -P,--params <FILE> Read parameters from FILE
+ * -T,--cutmethod <METHOD> Method to use for triming (hard|perc|prop|best|span)
+ * -t,--threshold <DOUBLE> Trim the alignment with regard to threshold
+ * -w,--workDir <DIR> The DIRectory containing the data to evaluate
* </pre>
*
* The input is taken in the current directory in a set of subdirectories (one per
@@ -220,6 +220,8 @@ public class GroupAggreg extends CommonCLI {
/**
* Print the aggregated alignment, it is not void...
+ * @param al: the alignment to be printed
+ * @param outputfilename: the name of the file in which to print it
*/
public void print( Alignment al, String outputfilename ) {
if ( al == null ) return;
diff --git a/src/fr/inrialpes/exmo/align/cli/GroupEval.java b/src/fr/inrialpes/exmo/align/cli/GroupEval.java
index ff8a7679..c2f90518 100644
--- a/src/fr/inrialpes/exmo/align/cli/GroupEval.java
+++ b/src/fr/inrialpes/exmo/align/cli/GroupEval.java
@@ -69,24 +69,24 @@ import fr.inrialpes.exmo.align.parser.AlignmentParser;
*
* where the options are:
* <pre>
- * -c,--color <COLOR> Color even lines of the output in COLOR (default:
+ * -c,--color <COLOR> Color even lines of the output in COLOR (default:
* lightblue)
- * -D <NAME=VALUE> Use value for given property
- * -d,--debug <LEVEL> debug argument is deprecated, use logging instead
+ * -D <NAME=VALUE> Use value for given property
+ * -d,--debug <LEVEL> debug argument is deprecated, use logging instead
* See http://alignapi.gforge.inria.fr/logging.html
- * -e,--evaluator <CLASS> Use CLASS as evaluation plotter
- * -f,--format <MEAS> Used MEASures and order
+ * -e,--evaluator <CLASS> Use CLASS as evaluation plotter
+ * -f,--format <MEAS> Used MEASures and order
* (precision/recall/f-measure/overall/time) (default:
* pr)
* -h,--help Print this page
- * -l,--list <FILE> List of FILEs to be included in the results (required)
- * -o,--output <FILE> Send output to FILE
- * -P,--params <FILE> Read parameters from FILE
- * -r,--reference <FILE> Name of the reference alignment FILE (default:
+ * -l,--list <FILE> List of FILEs to be included in the results (required)
+ * -o,--output <FILE> Send output to FILE
+ * -P,--params <FILE> Read parameters from FILE
+ * -r,--reference <FILE> Name of the reference alignment FILE (default:
* refalign.rdf)
- * -t,--type <TYPE> Output TYPE (html|xml|tex|ascii|triangle; default:
+ * -t,--type <TYPE> Output TYPE (html|xml|tex|ascii|triangle; default:
* html)
- * -w,--directory <DIR> The DIRectory containing the data to evaluate
+ * -w,--directory <DIR> The DIRectory containing the data to evaluate
* </pre>
*
* The input is taken in the current directory in a set of subdirectories (one per
diff --git a/src/fr/inrialpes/exmo/align/cli/TransformQuery.java b/src/fr/inrialpes/exmo/align/cli/TransformQuery.java
index 54c8429a..feec9f75 100644
--- a/src/fr/inrialpes/exmo/align/cli/TransformQuery.java
+++ b/src/fr/inrialpes/exmo/align/cli/TransformQuery.java
@@ -48,7 +48,7 @@ import org.semanticweb.owl.align.AlignmentException;
/**
* Transform a query according to an alignment
- * TransformQuery [-a alignmentURI] [-e] [-q query] < query
+ * {@literal TransformQuery [-a alignmentURI] [-e] [-q query] < query}
* Query can be taken from (priority):
* - parameter
* - a queryfile (-q)
diff --git a/src/fr/inrialpes/exmo/align/impl/BasicCell.java b/src/fr/inrialpes/exmo/align/impl/BasicCell.java
index e81fd3db..1d9b96b4 100644
--- a/src/fr/inrialpes/exmo/align/impl/BasicCell.java
+++ b/src/fr/inrialpes/exmo/align/impl/BasicCell.java
@@ -93,7 +93,7 @@ public class BasicCell implements Cell, Comparable<Cell>, Extensible {
/**
* Used to order the cells in an alignment:
- * -- this > c iff this.getStrength() < c.getStrength() --
+ * {@literal this > c iff this.getStrength() < c.getStrength() }
*/
public int compareTo( Cell c ){
if ( this == c ) return 0; // compatible with equals!
diff --git a/src/fr/inrialpes/exmo/align/impl/BasicOntologyNetwork.java b/src/fr/inrialpes/exmo/align/impl/BasicOntologyNetwork.java
index 041d1e37..fbcd2758 100644
--- a/src/fr/inrialpes/exmo/align/impl/BasicOntologyNetwork.java
+++ b/src/fr/inrialpes/exmo/align/impl/BasicOntologyNetwork.java
@@ -432,8 +432,7 @@ public class BasicOntologyNetwork implements OntologyNetwork, Extensible {
* Modifies the network
* TODO
* Alternative definition!
- * public void match( Class<? extends AlignmentProcess> method, boolean reflexive ) throws AlignmentException {
- }
+ * {@literal public void match( Class<? extends AlignmentProcess> method, boolean reflexive ) throws AlignmentException}
*/
public void match( String method, boolean reflexive, boolean symmetric, Properties params ) throws AlignmentException {
for ( OntologyTriple ot1 : ontologies.values() ) {
diff --git a/src/fr/inrialpes/exmo/align/impl/BasicParameters.java b/src/fr/inrialpes/exmo/align/impl/BasicParameters.java
index 52f52f22..04a4d02f 100644
--- a/src/fr/inrialpes/exmo/align/impl/BasicParameters.java
+++ b/src/fr/inrialpes/exmo/align/impl/BasicParameters.java
@@ -57,11 +57,11 @@ import org.semanticweb.owl.align.Parameters;
* are Strings (even if their type is Object).
*
* A note about unchecked warnings
- * java.util.Properties is declared as hashtable<Object,Object>
+ * java.util.Properties is declared as {@literal hashtable<Object,Object>}
* However all its accessors can only put String as key in the hashtable
- * But propertyNames returns Enumeration and not Enumeration<String>
- * Using keySet will not change anything, because it will be Set<Object>
- * Java 6 introduces Set<String> stringPropertyNames() !!
+ * But propertyNames returns Enumeration and not {@literal Enumeration<String>}
+ * Using keySet will not change anything, because it will be {@literal Set<Object>}
+ * Java 6 introduces {@literal Set<String> stringPropertyNames()} !!
*
* @author Jérôme Euzenat
* @version $Id$
diff --git a/src/fr/inrialpes/exmo/align/impl/DistanceAlignment.java b/src/fr/inrialpes/exmo/align/impl/DistanceAlignment.java
index 26b7dcf0..e0733f15 100644
--- a/src/fr/inrialpes/exmo/align/impl/DistanceAlignment.java
+++ b/src/fr/inrialpes/exmo/align/impl/DistanceAlignment.java
@@ -283,7 +283,7 @@ public abstract class DistanceAlignment extends ObjectAlignment implements Align
* exact algorithm using the Hungarian method.
* This algorithm contains several guards to prevent the HungarianAlgorithm to
* raise problems:
- * - It invert column and rows when nbrows > nbcol (Hungarian loops)
+ * - It invert column and rows when nbrows > nbcol (Hungarian loops)
* - It prevents to generate alignments when one category has no elements.
*/
@SuppressWarnings({"unchecked","rawTypes"}) //ConcatenatedIterator
diff --git a/src/fr/inrialpes/exmo/align/impl/Extensible.java b/src/fr/inrialpes/exmo/align/impl/Extensible.java
index a6734684..d125f5c2 100644
--- a/src/fr/inrialpes/exmo/align/impl/Extensible.java
+++ b/src/fr/inrialpes/exmo/align/impl/Extensible.java
@@ -1,16 +1,33 @@
/*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * $Id$
+ *
+ * Copyright (C) INRIA, 2015
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ * USA.
*/
+
package fr.inrialpes.exmo.align.impl;
import fr.inrialpes.exmo.align.impl.Extensions;
+
import java.util.Collection;
/**
*
- * @author Nicolas Guillouet <nicolas@meaningengines.com>
+ * @author Nicolas Guillouet (nicolas@meaningengines.com)
*/
public interface Extensible {
@@ -21,6 +38,7 @@ public interface Extensible {
* getExtensions returns a set of tripes: uri*label*value
* all three being String
*/
+
public Collection<String[]> getExtensions();
public String getExtension( String uri, String label );
public void setExtension( String uri, String label, String value );
diff --git a/src/fr/inrialpes/exmo/align/impl/ObjectCell.java b/src/fr/inrialpes/exmo/align/impl/ObjectCell.java
index 027f5425..27bc7730 100644
--- a/src/fr/inrialpes/exmo/align/impl/ObjectCell.java
+++ b/src/fr/inrialpes/exmo/align/impl/ObjectCell.java
@@ -55,7 +55,7 @@ public class ObjectCell extends BasicCell {
super( id, ob1, ob2, rel, m );
};
- /**
+ /*
* Used to order the cells in an alignment:
* -- this > c iff this.getStrength() < c.getStrength() --
public int compareTo( Cell c ){
diff --git a/src/fr/inrialpes/exmo/align/impl/edoal/Linkkey.java b/src/fr/inrialpes/exmo/align/impl/edoal/Linkkey.java
index f0358ae3..d4e8dea1 100644
--- a/src/fr/inrialpes/exmo/align/impl/edoal/Linkkey.java
+++ b/src/fr/inrialpes/exmo/align/impl/edoal/Linkkey.java
@@ -34,7 +34,7 @@ import org.semanticweb.owl.align.AlignmentException;
/**
*
- * @author Nicolas Guillouet <nicolas@meaningengines.com>
+ * @author Nicolas Guillouet (nicolas@meaningengines.com)
*/
public class Linkkey implements Extensible {
diff --git a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyBinding.java b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyBinding.java
index bb85d697..6021c297 100644
--- a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyBinding.java
+++ b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyBinding.java
@@ -25,7 +25,7 @@ import org.semanticweb.owl.align.AlignmentException;
/**
*
- * @author Nicolas Guillouet <nicolas@meaningengines.com>
+ * @author Nicolas Guillouet (nicolas@meaningengines.com)
*/
public abstract class LinkkeyBinding {
diff --git a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyEquals.java b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyEquals.java
index fdaa0f92..4ad7cbb0 100644
--- a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyEquals.java
+++ b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyEquals.java
@@ -25,7 +25,7 @@ import org.semanticweb.owl.align.AlignmentException;
/**
*
- * @author Nicolas Guillouet <nicolas@meaningengines.com>
+ * @author Nicolas Guillouet (nicolas@meaningengines.com)
*/
public class LinkkeyEquals extends LinkkeyBinding{
diff --git a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyIntersects.java b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyIntersects.java
index 94d5b0c1..026f7bfc 100644
--- a/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyIntersects.java
+++ b/src/fr/inrialpes/exmo/align/impl/edoal/LinkkeyIntersects.java
@@ -25,7 +25,7 @@ import org.semanticweb.owl.align.AlignmentException;
/**
*
- * @author Nicolas Guillouet <nicolas@meaningengines.com>
+ * @author Nicolas Guillouet (nicolas@meaningengines.com)
*/
public class LinkkeyIntersects extends LinkkeyBinding {
diff --git a/src/fr/inrialpes/exmo/align/impl/eval/ExtPREvaluator.java b/src/fr/inrialpes/exmo/align/impl/eval/ExtPREvaluator.java
index 829cd025..9fd98975 100644
--- a/src/fr/inrialpes/exmo/align/impl/eval/ExtPREvaluator.java
+++ b/src/fr/inrialpes/exmo/align/impl/eval/ExtPREvaluator.java
@@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory;
/**
* Implements extended precision and recall between alignments.
- * These are the measures corresponding to [Ehrig&Euzenat2005].
+ * These are the measures corresponding to [Ehrig and Euzenat 2005].
* The implementation is based on that of PRecEvaluator.
*
* This currently (4.4) implements all three mesures with the following
@@ -58,7 +58,7 @@ import org.slf4j.LoggerFactory;
* In the second case: 1, .5, .25, .125
* - it is possible to avoid using confidences (see below)
*
- * Dealing with confidence the way this was suggested in [Ehrig&Euzenat2005]
+ * Dealing with confidence the way this was suggested in [Ehrig and Euzenat2005]
* may not be a good idea as it seems. Indeed, typically incorrect correspondences
* are those with low confidence. Hence, when they are close to the target, the fact
* that the correspondence has a low confidence will penalise heavily the bonus
@@ -134,7 +134,7 @@ public class ExtPREvaluator extends BasicEvaluator implements Evaluator {
public int getFound() { return nbfound; }
/**
- * This is a partial implementation of [Ehrig & Euzenat 2005]
+ * This is a partial implementation of [Ehrig and Euzenat 2005]
* because the relations are not taken into account
* (they are supposed to be always =)
*/
@@ -209,7 +209,7 @@ public class ExtPREvaluator extends BasicEvaluator implements Evaluator {
* This computes similarity depending on structural measures:
* the similarity is symALPHA^(val1+val2), symALPHA being lower than 1.
* valx is the length of the subclass chain.
- * Table 1 (& 2) of [Ehrig2005]
+ * Table 1 (and 2) of [Ehrig and Euzenat 2005]
*/
protected double computeSymSimilarity( Cell c1, Alignment s2 ){
double sim = 0; // the similarity between the pair of elements
@@ -299,7 +299,7 @@ public class ExtPREvaluator extends BasicEvaluator implements Evaluator {
/**
* Oriented relaxed precision and recal similarity
- * Table 4 (& 5) of [Ehrig2005]
+ * Table 4 (and 5) of [Ehrig and Euzenat 2005]
*/
protected double computePrecisionOrientedSimilarity( Cell c1, Alignment s2 ){
double sim = 0; // the similarity between the pair of elements
@@ -352,7 +352,7 @@ public class ExtPREvaluator extends BasicEvaluator implements Evaluator {
/**
* Oriented relaxed precision and recal similarity
- * Table 6 (& 7) of [Ehrig2005]
+ * Table 6 (and 7) of [Ehrig and Euzenat 2005]
*/
protected double computeRecallOrientedSimilarity( Cell c1, Alignment s2 ){
double sim = 0; // the similarity between the pair of elements
diff --git a/src/fr/inrialpes/exmo/align/impl/eval/ROCCurveEvaluator.java b/src/fr/inrialpes/exmo/align/impl/eval/ROCCurveEvaluator.java
index 3ee5e8d2..0fd2cfb0 100644
--- a/src/fr/inrialpes/exmo/align/impl/eval/ROCCurveEvaluator.java
+++ b/src/fr/inrialpes/exmo/align/impl/eval/ROCCurveEvaluator.java
@@ -67,7 +67,7 @@ import java.net.URI;
* There are two ways of doing this:
* - simply Area/N*P, but this would advantage
* - considering the current subpart Area/N*|
- * => both would advantage matchers with high precision
+ * =< both would advantage matchers with high precision
* penalising them Area/N*P
* - interpolating the curve:
* NOT EASY, TO BE IMPLEMENTED
diff --git a/src/fr/inrialpes/exmo/align/impl/renderer/GraphPatternRendererVisitor.java b/src/fr/inrialpes/exmo/align/impl/renderer/GraphPatternRendererVisitor.java
index b476a5bf..b52a3562 100644
--- a/src/fr/inrialpes/exmo/align/impl/renderer/GraphPatternRendererVisitor.java
+++ b/src/fr/inrialpes/exmo/align/impl/renderer/GraphPatternRendererVisitor.java
@@ -273,7 +273,6 @@ public abstract class GraphPatternRendererVisitor extends IndentedRendererVisito
* Produce Query only for local call.
*
* @param referer
- * @param index
* @return
*/
public String getQuery( Object referer ) {
diff --git a/src/fr/inrialpes/exmo/align/impl/renderer/JSONRendererVisitor.java b/src/fr/inrialpes/exmo/align/impl/renderer/JSONRendererVisitor.java
index c3067b0f..5988932b 100644
--- a/src/fr/inrialpes/exmo/align/impl/renderer/JSONRendererVisitor.java
+++ b/src/fr/inrialpes/exmo/align/impl/renderer/JSONRendererVisitor.java
@@ -84,7 +84,7 @@ import java.util.Collection;
* Renders an alignment in JSON (and in fact in JSON-LD) IETF RFC 7159 +
* http://www.w3.org/TR/json-ld/
*
- * application/json <========= media type available
+ * application/json : media type available
*
* @author Jérôme Euzenat
* @version $Id$
diff --git a/src/fr/inrialpes/exmo/align/impl/renderer/OWLAxiomsRendererVisitor.java b/src/fr/inrialpes/exmo/align/impl/renderer/OWLAxiomsRendererVisitor.java
index 71d29fd3..b503399c 100644
--- a/src/fr/inrialpes/exmo/align/impl/renderer/OWLAxiomsRendererVisitor.java
+++ b/src/fr/inrialpes/exmo/align/impl/renderer/OWLAxiomsRendererVisitor.java
@@ -839,7 +839,7 @@ public class OWLAxiomsRendererVisitor extends IndentedRendererVisitor implements
* Our Datatypes are only strings identifying datatypes.
* For OWL, they should be considered as built-in types because we do
* not know how to add other types.
- * Hence we could simply have used a rdfs:Datatype="<name>"
+ * Hence we could simply have used a rdfs:Datatype="<name>"
*
* OWL offers further possiblities, such as additional owl:withRestriction
* clauses
diff --git a/src/fr/inrialpes/exmo/align/parser/SyntaxElement.java b/src/fr/inrialpes/exmo/align/parser/SyntaxElement.java
index da5a0640..6b05f47c 100644
--- a/src/fr/inrialpes/exmo/align/parser/SyntaxElement.java
+++ b/src/fr/inrialpes/exmo/align/parser/SyntaxElement.java
@@ -186,12 +186,14 @@ public enum SyntaxElement {
/**
* Constructor which takes the name and the namespace of the element.
*
- * @param namespace for the element
- * @param name for the element
+ * @param ns: namespace for the element
+ * @param name: the name for the element
+ * @param op:
+ * @param prp: if the element is a property
* @throws NullPointerException if the name or the namespace is
* <code>null</code>
*/
- private SyntaxElement(final Namespace ns, final String name, final Constructor op, final boolean prp) {
+ private SyntaxElement( final Namespace ns, final String name, final Constructor op, final boolean prp) {
if ((name == null) || (ns == null)) {
throw new NullPointerException("The name and the namespace must not be null");
}
@@ -258,18 +260,14 @@ public enum SyntaxElement {
}
/**
- * Returns the namespace of the element.
- *
- * @return the namespace
+ * @return the namespace of the element
*/
public Namespace getNamespace() {
return namespace;
}
/**
- * Returns the resource of the element.
- *
- * @return the resource
+ * @return the resource of the element.
*/
public static Object getResource(String name) throws AlignmentException {
if (register == null) {
@@ -279,9 +277,7 @@ public enum SyntaxElement {
}
/**
- * Returns the namespace of the element.
- *
- * @return the namespace
+ * @return the constructor of the element.
*/
public Constructor getOperator() {
return operator;
diff --git a/src/fr/inrialpes/exmo/align/parser/TypeCheckingVisitor.java b/src/fr/inrialpes/exmo/align/parser/TypeCheckingVisitor.java
index 2e722538..fbb84bbb 100644
--- a/src/fr/inrialpes/exmo/align/parser/TypeCheckingVisitor.java
+++ b/src/fr/inrialpes/exmo/align/parser/TypeCheckingVisitor.java
@@ -66,7 +66,7 @@ import fr.inrialpes.exmo.align.impl.edoal.LinkkeyBinding;
/**
* Checks if an EDOALAlignment is well-typed
- * This is called by AlignmentParser (with debug>0)
+ * This is called by AlignmentParser (with debug > 0)
*
* @author Jérôme Euzenat
* @version $Id$
diff --git a/src/fr/inrialpes/exmo/align/service/SQLCache.java b/src/fr/inrialpes/exmo/align/service/SQLCache.java
index 38c3a46d..f20e5baa 100644
--- a/src/fr/inrialpes/exmo/align/service/SQLCache.java
+++ b/src/fr/inrialpes/exmo/align/service/SQLCache.java
@@ -329,7 +329,7 @@ public class SQLCache extends VolatilCache implements Cache {
*
* should be invoked when:
* ( result.getExtension(CACHED) == ""
- * && result.getExtension(STORED) != "") {
+ * AND result.getExtension(STORED) != "") {
*/
protected Alignment retrieveAlignment( String uri, Alignment alignment ) throws SQLException, AlignmentException, URISyntaxException {
diff --git a/src/fr/inrialpes/exmo/align/service/VolatilCache.java b/src/fr/inrialpes/exmo/align/service/VolatilCache.java
index 47e624e4..e41eb00c 100644
--- a/src/fr/inrialpes/exmo/align/service/VolatilCache.java
+++ b/src/fr/inrialpes/exmo/align/service/VolatilCache.java
@@ -281,8 +281,8 @@ public class VolatilCache implements Cache {
* (2) if not, generate a *local* cell id if necessary and add ##
* (3) use these cell-id in the extension part...
* STORE:
- * if cell has extension && no id, create cell id, store it in db, not in setId
- * if cell has extension && id, us it with getId/setId
+ * if cell has extension and no id, then create cell id, store it in db, not in setId
+ * if cell has extension and id, then use it with getId/setId
* UNSTORE:
* suppress those extensions with the cell_id if exists
* LOAD-FROM-DB:
@@ -369,7 +369,7 @@ public class VolatilCache implements Cache {
*
* should be invoked when:
* ( result.getExtension(CACHED) != ""
- * && obviously result.getExtension(STORED) != ""
+ * AND obviously result.getExtension(STORED) != ""
*/
protected void flushAlignment( Alignment alignment ) {// throws AlignmentException
//alignment.removeAllCells();
diff --git a/src/fr/inrialpes/exmo/ontowrap/OntologyCache.java b/src/fr/inrialpes/exmo/ontowrap/OntologyCache.java
index a1ccfa7e..7656ec7f 100644
--- a/src/fr/inrialpes/exmo/ontowrap/OntologyCache.java
+++ b/src/fr/inrialpes/exmo/ontowrap/OntologyCache.java
@@ -42,10 +42,9 @@ import org.slf4j.LoggerFactory;
public class OntologyCache <O extends LoadedOntology<? extends Object>> {
final static Logger logger = LoggerFactory.getLogger( OntologyCache.class );
- /** The list of currently loaded ontologies as a function:
- * URI --> Ontology
- * This is the ontology URI, NOT its filename
- */
+ // The list of currently loaded ontologies as a function:
+ // URI --> Ontology
+ // This is the ontology URI, NOT its filename
Hashtable<URI,O> ontologies = null;
Hashtable<URI,O> ontologyUris = null;
diff --git a/src/org/semanticweb/owl/align/Alignment.java b/src/org/semanticweb/owl/align/Alignment.java
index a1e47ada..c7a99901 100644
--- a/src/org/semanticweb/owl/align/Alignment.java
+++ b/src/org/semanticweb/owl/align/Alignment.java
@@ -33,6 +33,10 @@ import org.xml.sax.ContentHandler;
/**
* Represents an Ontology alignment.
*
+ * The alignment has reference to the two aligned ontology.
+ * All Alignment cells contain first the entity from the first ontology
+ * The alignment is from the first ontology to the second.
+ *
* @author Jérôme Euzenat
* @version $Id$
*/
@@ -40,24 +44,24 @@ import org.xml.sax.ContentHandler;
public interface Alignment extends Cloneable, Iterable<Cell>, Visitable {
- /** Initialize the alignement before using it **/
- /** This should return an Alignment and not be void **/
+ /** Initialize the alignement before using it
+ * @param onto1, @param onto2: the two ontologies aligned
+ * @throws AlignmentException
+ **/
public void init( Object onto1, Object onto2 ) throws AlignmentException;
/**
* Initialize the alignement before using it, with some ontology caching trick
* //@deprecated The OntologyCache is now internal, use init( onto1, onto2 ) instead
+ * @param onto1, @param onto2: the two ontologies aligned
+ * @param cache: a cache where to find and store the ontologies
+ * @throws AlignmentException
**/
//@Deprecated
public void init( Object onto1, Object onto2, Object cache ) throws AlignmentException;
/** Alignment methods **/
- /**
- * The alignment has reference to the two aligned ontology.
- * All Alignment cells contain firts the entity from the first ontology
- * The alignment is from the first ontology to the second.
- */
public Object getOntology1();
public Object getOntology2();
public URI getOntology1URI() throws AlignmentException;
--
GitLab