From 50939d280cbc000330c6f0dc68d756ecd67818bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Euzenat?= <Jerome.Euzenat@inria.fr>
Date: Fri, 8 Feb 2008 20:55:59 +0000
Subject: [PATCH] - corrected Javadoc
---
.../exmo/align/ling/JWNLDistances.java | 42 -------------------
.../exmo/align/parser/AlignmentParser.java | 2 +-
.../exmo/align/service/HTMLAServProfile.java | 8 ++--
.../exmo/align/service/QueryMediator.java | 13 +++---
.../exmo/queryprocessor/QueryProcessor.java | 8 ++--
.../exmo/queryprocessor/RDFGraph.java | 6 +--
.../inrialpes/exmo/queryprocessor/Result.java | 27 ++++++++----
7 files changed, 38 insertions(+), 68 deletions(-)
diff --git a/src/fr/inrialpes/exmo/align/ling/JWNLDistances.java b/src/fr/inrialpes/exmo/align/ling/JWNLDistances.java
index 30355282..85d2aeb1 100644
--- a/src/fr/inrialpes/exmo/align/ling/JWNLDistances.java
+++ b/src/fr/inrialpes/exmo/align/ling/JWNLDistances.java
@@ -239,46 +239,6 @@ public class JWNLDistances {
// return sim;
}
- /**
- * Updates the values contained in specified mask and results matrix.
- * @param hash1 First hashtable (<i>eg.</i> containing the nouns
- * of the first ontology).
- * @param hash2 Second hashtable (<i>eg.</i> containing the nouns
- * of the second ontology).
- * @param mask A mask matrix.
- * @param results A result matrix.
- * @deprecated The use of a mask is deprecated.
- private void updateMaskAndResults(Hashtable hash1, Hashtable hash2, double[][] mask, double[][] results) {
- Enumeration enum1, enum2;
- String token1, token2;
- IndexWord index1, index2;
- int x, y;
- double nb1, nb2;
-
- x = 0;
- y = 0;
- enum1 = hash1.keys();
- while (enum1.hasMoreElements()) {
- token1 = (String) enum1.nextElement();
- index1 = (IndexWord) hash1.get(token1);
- enum2 = hash2.keys();
- while (enum2.hasMoreElements()) {
- token2 = (String) enum2.nextElement();
- index2 = (IndexWord) hash2.get(token2);
-
- nb1 = getNumberOfOccurences(token1, 1);
- nb2 = getNumberOfOccurences(token2, 2);
-
- mask[x][y] = 2 / (nb1 + nb2);
- results[x][y] = computeTokenSimilarity(index1, index2);
-
- y++;
- }
- x++;
- }
- }
- */
-
public double compareComponentNames(String s1, String s2) {
Vector s1Tokens;
Vector s2Tokens;
@@ -741,7 +701,6 @@ public class JWNLDistances {
/**
* TODO Look up for other things than nouns
* @param word
- * @return
*/
public void lookUpWord(String word, Hashtable nouns, Hashtable adjectives,
Hashtable verbs) {
@@ -844,7 +803,6 @@ public class JWNLDistances {
}
/**
- * @author Philippe Guégan
* @param token A token.
* @param n The number of the ontology (typically 1 or 2).
* @return the number of occurences of the token in the hashtables
diff --git a/src/fr/inrialpes/exmo/align/parser/AlignmentParser.java b/src/fr/inrialpes/exmo/align/parser/AlignmentParser.java
index ef38770a..8a6fe127 100644
--- a/src/fr/inrialpes/exmo/align/parser/AlignmentParser.java
+++ b/src/fr/inrialpes/exmo/align/parser/AlignmentParser.java
@@ -371,7 +371,7 @@ public class AlignmentParser extends DefaultHandler {
*
* @param namespaceURI The namespace of the current element
* @param pName The local name of the current element
- * @param qname The name of the current element
+ * @param qName The name of the current element
*/
public void endElement(String namespaceURI, String pName, String qName ) throws SAXException {
if(debugMode > 2)
diff --git a/src/fr/inrialpes/exmo/align/service/HTMLAServProfile.java b/src/fr/inrialpes/exmo/align/service/HTMLAServProfile.java
index f9e4c78c..5d8f26cc 100644
--- a/src/fr/inrialpes/exmo/align/service/HTMLAServProfile.java
+++ b/src/fr/inrialpes/exmo/align/service/HTMLAServProfile.java
@@ -259,10 +259,10 @@ public class HTMLAServProfile implements AlignmentServiceProfile {
*
* (By default, this delegates to serveFile() and allows directory listing.)
*
- * @parm uri Percent-decoded URI without parameters, for example "/index.cgi"
- * @parm method "GET", "POST" etc.
- * @parm parms Parsed, percent decoded parameters from URI and, in case of POST, data.
- * @parm header Header entries, percent decoded
+ * @param uri Percent-decoded URI without parameters, for example "/index.cgi"
+ * @param method "GET", "POST" etc.
+ * @param parms Parsed, percent decoded parameters from URI and, in case of POST, data.
+ * @param header Header entries, percent decoded
* @return HTTP response, see class Response for details
*/
public Response serve( String uri, String method, Properties header, Properties parms ) {
diff --git a/src/fr/inrialpes/exmo/align/service/QueryMediator.java b/src/fr/inrialpes/exmo/align/service/QueryMediator.java
index 32e1afda..946bb810 100644
--- a/src/fr/inrialpes/exmo/align/service/QueryMediator.java
+++ b/src/fr/inrialpes/exmo/align/service/QueryMediator.java
@@ -1,7 +1,7 @@
/*
* $Id$
*
- * Copyright (C) INRIA Rhône-Alpes, 2006-2007
+ * Copyright (C) INRIA Rhône-Alpes, 2006-2008
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
@@ -95,7 +95,7 @@ public class QueryMediator implements QueryProcessor {
/**
* @param query -- The query string
* @param type -- The query type, can be one of SELECT, ASK, CONSTRUCT, or DESCRIBE
- * @returns Result, result form depends on type
+ * @return Result, result form depends on type
*/
// JE: There is a flaw in the query API: it should be defined with
// throws QueryException because if something fails, this will be
@@ -119,7 +119,7 @@ public class QueryMediator implements QueryProcessor {
/**
*@param query -- The query string
- *@returns query results as string
+ *@return query results as string
*/
public String queryWithStringResults(String query) {
try {
@@ -130,7 +130,7 @@ public class QueryMediator implements QueryProcessor {
/**
*@param query -- the query string
- *@returns the type of the query
+ *@return the type of the query
*/
public int getType(String query){
return processor.getType( query );
@@ -141,9 +141,8 @@ public class QueryMediator implements QueryProcessor {
}
/**
- * @param aQuery query to be re-written
- * @param a the alignment used for rewriting the query Alignment
- * @ return -- rewritten query:
+ * @param aQuery -- query to be re-written
+ * @return -- rewritten query:
* - replaces all the prefix namespaces, if present, in the query by actual IRIs
* - replaces all entity IRI by their counterpart in the ontology
*
diff --git a/src/fr/inrialpes/exmo/queryprocessor/QueryProcessor.java b/src/fr/inrialpes/exmo/queryprocessor/QueryProcessor.java
index 6dc31837..2527eaab 100644
--- a/src/fr/inrialpes/exmo/queryprocessor/QueryProcessor.java
+++ b/src/fr/inrialpes/exmo/queryprocessor/QueryProcessor.java
@@ -1,7 +1,7 @@
/*
* $Id$
*
- * Copyright (C) INRIA Rhône-Alpes, 2006
+ * Copyright (C) INRIA Rhône-Alpes, 2006, 2008
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -35,7 +35,7 @@ public interface QueryProcessor {
/**
* @param query -- The query string
* @param type -- The query type, can be one of SELECT, ASK, CONSTRUCT, or DESCRIBE
- * @returns Result, result form depends on type
+ * @return Result, result form depends on type
*/
public Result query(String query, Type type);
@@ -46,13 +46,13 @@ public interface QueryProcessor {
/**
*@param query -- The query string
- *@returns query results as string
+ *@return query results as string
*/
public String queryWithStringResults(String query);
/**
*@param query -- the query string
- *@returns the type of the query
+ *@return the type of the query
*/
public int getType(String query);
diff --git a/src/fr/inrialpes/exmo/queryprocessor/RDFGraph.java b/src/fr/inrialpes/exmo/queryprocessor/RDFGraph.java
index 3532df7a..8e635f91 100644
--- a/src/fr/inrialpes/exmo/queryprocessor/RDFGraph.java
+++ b/src/fr/inrialpes/exmo/queryprocessor/RDFGraph.java
@@ -1,7 +1,7 @@
/*
* $Id$
*
- * Copyright (C) INRIA Rhône-Alpes, 2006
+ * Copyright (C) INRIA Rhône-Alpes, 2006, 2008
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -33,11 +33,11 @@ package fr.inrialpes.exmo.queryprocessor;
*/
public interface RDFGraph {
/**
- *@returns RDF/XML representation of the graph
+ *@return RDF/XML representation of the graph
*/
public String getXML();
- /**@returns rdf triples
+ /**@return rdf triples
*/
public Triple[] getTriples();
diff --git a/src/fr/inrialpes/exmo/queryprocessor/Result.java b/src/fr/inrialpes/exmo/queryprocessor/Result.java
index c5ad0a8b..7135d02d 100644
--- a/src/fr/inrialpes/exmo/queryprocessor/Result.java
+++ b/src/fr/inrialpes/exmo/queryprocessor/Result.java
@@ -1,8 +1,21 @@
/*
- * Result.java
+ * $Id$
*
- * Created on March 20, 2006, 10:55 AM
+ * Copyright (C) INRIA Rhône-Alpes, 2006, 2008
*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU 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.queryprocessor;
@@ -14,24 +27,24 @@ import java.util.Collection;
* @author Arun Sharma
*/
public interface Result {
- /**@returns the type of the result set
+ /**@return the type of the result set
*/
public int getType();
- /**@returns the reslut for ASK type queries
+ /**@return the reslut for ASK type queries
*/
public boolean getAskResult() throws QueryTypeMismatchException;
/**
- *@returns the RDF graph for construct queries
+ *@return the RDF graph for construct queries
*/
public RDFGraph getConstructResult() throws QueryTypeMismatchException;
- /**@returns a collection set for SELECT queries
+ /**@return a collection set for SELECT queries
*/
public Collection getSelectResult() throws QueryTypeMismatchException;
- /**@returns an XML string for the SELECT queries
+ /**@return an XML string for the SELECT queries
*/
public String getSelectResultasXML() throws QueryTypeMismatchException;
--
GitLab