ANY23-297 Any23 doesn't build under JDK1.8
Project: http://git-wip-us.apache.org/repos/asf/any23/repo Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/bb556858 Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/bb556858 Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/bb556858 Branch: refs/heads/master Commit: bb55685859a26b36ca4a9893bb93aa9eb7687b8c Parents: 120b5a4 Author: Lewis John McGibbney <[email protected]> Authored: Fri Nov 25 13:33:57 2016 -0800 Committer: Lewis John McGibbney <[email protected]> Committed: Fri Nov 25 13:33:57 2016 -0800 ---------------------------------------------------------------------- .../main/java/org/apache/any23/cli/Tool.java | 2 - .../any23/configuration/Configuration.java | 4 +- .../apache/any23/encoding/EncodingDetector.java | 1 + .../any23/extractor/ExtractionParameters.java | 61 +++++++------- .../any23/extractor/ExtractionResult.java | 3 +- .../any23/extractor/ExtractorFactory.java | 2 + .../any23/extractor/ExtractorRegistry.java | 3 +- .../org/apache/any23/extractor/IssueReport.java | 2 +- .../java/org/apache/any23/mime/MIMEType.java | 36 ++++---- .../apache/any23/mime/purifier/Purifier.java | 6 +- .../apache/any23/plugin/Any23PluginManager.java | 57 +++++++------ .../apache/any23/plugin/ExtractorPlugin.java | 4 +- .../org/apache/any23/source/DocumentSource.java | 5 +- .../main/java/org/apache/any23/vocab/CSV.java | 12 +-- .../java/org/apache/any23/vocab/DCTerms.java | 22 ++--- .../org/apache/any23/vocab/LKIFCoreRules.java | 2 +- .../main/java/org/apache/any23/vocab/OGP.java | 2 +- .../java/org/apache/any23/vocab/Programme.java | 4 +- .../main/java/org/apache/any23/vocab/WO.java | 2 +- .../org/apache/any23/writer/TripleHandler.java | 18 ++-- core/src/main/java/org/apache/any23/Any23.java | 38 +++++---- .../any23/cli/ExtractorDocumentation.java | 16 ++-- .../any23/extractor/ExtractionResultImpl.java | 10 ++- .../any23/extractor/ExtractorRegistryImpl.java | 2 +- .../extractor/SingleDocumentExtraction.java | 6 +- .../apache/any23/extractor/html/DomUtils.java | 35 +++++--- .../html/EntityBasedMicroformatExtractor.java | 2 +- .../any23/extractor/html/HTMLDocument.java | 8 +- .../any23/extractor/html/LicenseExtractor.java | 1 - .../extractor/html/MicroformatExtractor.java | 10 ++- .../any23/extractor/html/SpeciesExtractor.java | 2 +- .../any23/extractor/html/TagSoupParser.java | 18 ++-- .../extractor/microdata/ItemPropValue.java | 3 - .../any23/extractor/microdata/ItemScope.java | 8 +- .../extractor/microdata/MicrodataParser.java | 12 +-- .../any23/extractor/rdf/RDFParserFactory.java | 2 +- .../any23/extractor/rdfa/RDFa11Parser.java | 13 +-- .../any23/extractor/xpath/QuadTemplate.java | 6 +- .../xpath/TemplateXPathExtractionRule.java | 2 +- .../apache/any23/http/AcceptHeaderBuilder.java | 3 +- .../apache/any23/http/DefaultHTTPClient.java | 5 +- .../http/DefaultHTTPClientConfiguration.java | 6 +- .../any23/rdf/Any23ValueFactoryWrapper.java | 8 +- .../java/org/apache/any23/rdf/RDFUtils.java | 88 +++++++++++++++----- .../org/apache/any23/util/DiscoveryUtils.java | 1 - .../java/org/apache/any23/util/FileUtils.java | 12 +-- .../java/org/apache/any23/util/StreamUtils.java | 2 +- .../java/org/apache/any23/util/StringUtils.java | 10 +-- .../org/apache/any23/validator/DOMDocument.java | 2 +- .../org/apache/any23/validator/RuleContext.java | 8 +- .../validator/ValidationReportSerializer.java | 1 + .../org/apache/any23/validator/Validator.java | 10 +-- .../org/apache/any23/vocab/RDFSchemaUtils.java | 8 +- .../any23/writer/BenchmarkTripleHandler.java | 1 + .../apache/any23/mime/TikaMIMETypeDetector.java | 13 +-- .../htmlscraper/HTMLScraperExtractor.java | 3 +- pom.xml | 4 +- .../servlet/conneg/ContentTypeNegotiator.java | 7 +- .../any23/servlet/conneg/MediaRangeSpec.java | 6 +- 59 files changed, 365 insertions(+), 275 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/cli/Tool.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/cli/Tool.java b/api/src/main/java/org/apache/any23/cli/Tool.java index 1f03c43..e4d6dc2 100644 --- a/api/src/main/java/org/apache/any23/cli/Tool.java +++ b/api/src/main/java/org/apache/any23/cli/Tool.java @@ -26,8 +26,6 @@ public interface Tool { /** * Runs the tool and retrieves the exit code. - * - * @return exit code. */ void run() throws Exception; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/configuration/Configuration.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/configuration/Configuration.java b/api/src/main/java/org/apache/any23/configuration/Configuration.java index 4255e30..83e0685 100644 --- a/api/src/main/java/org/apache/any23/configuration/Configuration.java +++ b/api/src/main/java/org/apache/any23/configuration/Configuration.java @@ -18,7 +18,7 @@ package org.apache.any23.configuration; /** - * Defines the main <i>Any23</code> configuration. + * Defines the main <i>Any23</i> configuration. */ public interface Configuration { @@ -33,7 +33,7 @@ public interface Configuration { * Checks whether a property is defined or not in configuration. * * @param propertyName name of property to check. - * @return <code>true</code> if defined, </code>false</code> otherwise. + * @return <i>true</i> if defined, <i>false</i> otherwise. */ boolean defineProperty(String propertyName); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/encoding/EncodingDetector.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/encoding/EncodingDetector.java b/api/src/main/java/org/apache/any23/encoding/EncodingDetector.java index 8ab5162..28faa9c 100644 --- a/api/src/main/java/org/apache/any23/encoding/EncodingDetector.java +++ b/api/src/main/java/org/apache/any23/encoding/EncodingDetector.java @@ -33,6 +33,7 @@ public interface EncodingDetector { * @param input the input stream containing the data. * @return a string compliant to * <a href="http://www.iana.org/assignments/character-sets";>IANA Charset Specification</a>. + * @throws IOException if there is an errorwhilst guessing the encoding. */ String guessEncoding(InputStream input) throws IOException; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/extractor/ExtractionParameters.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/extractor/ExtractionParameters.java b/api/src/main/java/org/apache/any23/extractor/ExtractionParameters.java index f1feb89..6189686 100644 --- a/api/src/main/java/org/apache/any23/extractor/ExtractionParameters.java +++ b/api/src/main/java/org/apache/any23/extractor/ExtractionParameters.java @@ -25,38 +25,11 @@ import java.util.Map; /** * This class models the parameters to be used to perform an extraction. - * - * @see org.apache.any23.Any23 + * See org.apache.any23.Any23 for more details. * @author Michele Mostarda ([email protected]) */ public class ExtractionParameters { - /** - * @param c the underlying configuration. - * @return the default extraction parameters. - */ - public static final ExtractionParameters newDefault(Configuration c) { - return new ExtractionParameters(c, ValidationMode.None); - } - - /** - * Creates the default extraction parameters with {@link org.apache.any23.configuration.DefaultConfiguration}. - * - * @return the default extraction parameters. - */ - public static final ExtractionParameters newDefault() { - return new ExtractionParameters(DefaultConfiguration.singleton(), ValidationMode.None); - } - - /** - * Declares the supported validation actions. - */ - public enum ValidationMode { - None, - Validate, - ValidateAndFix - } - private final Configuration configuration; private final ValidationMode extractionMode; @@ -123,7 +96,7 @@ public class ExtractionParameters { /** * Constructor, allows to set explicitly the value for flag - * {@link SingleDocumentExtraction#METADATA_NESTING_FLAG}. + * SingleDocumentExtraction#METADATA_NESTING_FLAG. * * @param configuration the underlying configuration. * @param extractionMode specifies the required extraction mode. @@ -137,9 +110,7 @@ public class ExtractionParameters { /** * */ - private static final long serialVersionUID = 1L; - - { + private static final long serialVersionUID = 1L; { put(ExtractionParameters.METADATA_NESTING_FLAG, nesting); }}, null @@ -147,6 +118,32 @@ public class ExtractionParameters { } /** + * @param c the underlying configuration. + * @return the default extraction parameters. + */ + public static final ExtractionParameters newDefault(Configuration c) { + return new ExtractionParameters(c, ValidationMode.None); + } + + /** + * Creates the default extraction parameters with {@link org.apache.any23.configuration.DefaultConfiguration}. + * + * @return the default extraction parameters. + */ + public static final ExtractionParameters newDefault() { + return new ExtractionParameters(DefaultConfiguration.singleton(), ValidationMode.None); + } + + /** + * Declares the supported validation actions. + */ + public enum ValidationMode { + None, + Validate, + ValidateAndFix + } + + /** * @return <code>true</code> if validation is active. */ public boolean isValidate() { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/extractor/ExtractionResult.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/extractor/ExtractionResult.java b/api/src/main/java/org/apache/any23/extractor/ExtractionResult.java index c302489..6c0a06b 100644 --- a/api/src/main/java/org/apache/any23/extractor/ExtractionResult.java +++ b/api/src/main/java/org/apache/any23/extractor/ExtractionResult.java @@ -56,8 +56,7 @@ public interface ExtractionResult extends IssueReport { void writeNamespace(String prefix, String uri); /** - * Close the result. - * <p/> + * <p>Close the result.</p> * Extractors should close their results as soon as possible, but * don't have to, the environment will close any remaining ones. * Implementations should be robust against multiple close() http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/extractor/ExtractorFactory.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/extractor/ExtractorFactory.java b/api/src/main/java/org/apache/any23/extractor/ExtractorFactory.java index 859f655..fd42324 100644 --- a/api/src/main/java/org/apache/any23/extractor/ExtractorFactory.java +++ b/api/src/main/java/org/apache/any23/extractor/ExtractorFactory.java @@ -37,6 +37,7 @@ public interface ExtractorFactory<T extends Extractor<?>> extends ExtractorDescr /** * Supports wildcards, e.g. <code>"*/*"</code> for blind extractors that merely call a web service. + * @return a {@link java.util.Collection} of supported mimetypes. */ Collection<MIMEType> getSupportedMIMETypes(); @@ -50,6 +51,7 @@ public interface ExtractorFactory<T extends Extractor<?>> extends ExtractorDescr * a short file that produces characteristic output if sent through the * extractor. The file will be read as UTF-8, so it should either use that * encoding or avoid characters outside of the US-ASCII range. + * @return a string representing sample input for a particular extractor. */ String getExampleInput(); } http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/extractor/ExtractorRegistry.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/extractor/ExtractorRegistry.java b/api/src/main/java/org/apache/any23/extractor/ExtractorRegistry.java index 484b0f0..dea9fca 100644 --- a/api/src/main/java/org/apache/any23/extractor/ExtractorRegistry.java +++ b/api/src/main/java/org/apache/any23/extractor/ExtractorRegistry.java @@ -30,7 +30,7 @@ public interface ExtractorRegistry { /** * Registers an {@link ExtractorFactory}. * - * @param factory + * @param factory an {@link ExtractorFactory} to register. * @throws IllegalArgumentException * if trying to register a {@link ExtractorFactory} that already * exists in the registry. @@ -78,6 +78,7 @@ public interface ExtractorRegistry { /** * Returns the names of all registered extractors, sorted alphabetically. + * @return an alphabetically sorted {@link java.util.List} */ List<String> getAllNames(); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/extractor/IssueReport.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/extractor/IssueReport.java b/api/src/main/java/org/apache/any23/extractor/IssueReport.java index 4bdf7cd..6a2615c 100644 --- a/api/src/main/java/org/apache/any23/extractor/IssueReport.java +++ b/api/src/main/java/org/apache/any23/extractor/IssueReport.java @@ -40,7 +40,7 @@ public interface IssueReport { /** * Prints out the content of the report. * - * @param ps + * @param ps a {@link java.io.PrintStream} to use for generating the report. */ void printReport(PrintStream ps); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/mime/MIMEType.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/mime/MIMEType.java b/api/src/main/java/org/apache/any23/mime/MIMEType.java index 6fdc171..76d2d9e 100644 --- a/api/src/main/java/org/apache/any23/mime/MIMEType.java +++ b/api/src/main/java/org/apache/any23/mime/MIMEType.java @@ -24,7 +24,7 @@ package org.apache.any23.mime; */ public class MIMEType implements Comparable<MIMEType> { - private final static String MSG = "Cannot parse MIME type (expected type/subtype[;q=x.y] format): "; + private static final String MSG = "Cannot parse MIME type (expected type/subtype[;q=x.y] format): "; private final String type; @@ -32,6 +32,12 @@ public class MIMEType implements Comparable<MIMEType> { private final double q; + private MIMEType(String type, String subtype, double q) { + this.type = type; + this.subtype = subtype; + this.q = q; + } + /** * Parses the given MIME type string returning an instance of * {@link MIMEType}. @@ -39,20 +45,26 @@ public class MIMEType implements Comparable<MIMEType> { * <code>type/subtype[;q=x.y]</code> . * An example of valid mime type is: <code>application/rdf+xml;q=0.9</code> * - * @param mimeType + * @param mimeType a provided mimetype string. * @return the mime type instance. * @throws IllegalArgumentException if the <code>mimeType</code> is not well formatted. */ public static MIMEType parse(String mimeType) { - if (mimeType == null) return null; + if (mimeType == null) { + return null; + } int i = mimeType.indexOf(';'); double q = 1.0; if (i > -1) { String[] params = mimeType.substring(i + 1).split(";"); for (String param : params) { int i2 = param.indexOf('='); - if (i2 == -1) continue; - if (!"q".equals(param.substring(0, i2).trim().toLowerCase())) continue; + if (i2 == -1) { + continue; + } + if (!"q".equals(param.substring(0, i2).trim().toLowerCase())){ + continue; + } String value = param.substring(i2 + 1); try { q = Double.parseDouble(value); @@ -85,18 +97,12 @@ public class MIMEType implements Comparable<MIMEType> { return new MIMEType(p1, p2, q); } - private MIMEType(String type, String subtype, double q) { - this.type = type; - this.subtype = subtype; - this.q = q; - } - public String getMajorType() { - return (type == null ? "*" : type); + return type == null ? "*" : type; } public String getSubtype() { - return (subtype == null ? "*" : subtype); + return subtype == null ? "*" : subtype; } public String getFullType() { @@ -115,6 +121,7 @@ public class MIMEType implements Comparable<MIMEType> { return subtype == null; } + @Override public String toString() { if (q == 1.0) { return getFullType(); @@ -122,8 +129,9 @@ public class MIMEType implements Comparable<MIMEType> { return getFullType() + ";q=" + q; } + @Override public int compareTo(MIMEType other) { return getFullType().compareTo(other.getFullType()); } - + } http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/mime/purifier/Purifier.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/mime/purifier/Purifier.java b/api/src/main/java/org/apache/any23/mime/purifier/Purifier.java index 9e19733..5e072a5 100644 --- a/api/src/main/java/org/apache/any23/mime/purifier/Purifier.java +++ b/api/src/main/java/org/apache/any23/mime/purifier/Purifier.java @@ -22,9 +22,8 @@ import java.io.InputStream; /** * This interface defines a minimum set of methods that - * a {@link org.apache.any23.mime.TikaMIMETypeDetector} could - * call in order to clean the input before performing the <i>MIME type</i> - * detection. + * a TikaMIMETypeDetector could call in order to clean the input + * before performing the <i>MIME type</i> detection. * * @author Davide Palmisano ( [email protected] ) */ @@ -34,6 +33,7 @@ public interface Purifier { * Performs the purification of the provided resettable {@link java.io.InputStream}. * * @param inputStream a resettable {@link java.io.InputStream} to be cleaned. + * @throws IOException if there is an error accessing the {@link java.io.InputStream} */ void purify(InputStream inputStream) throws IOException; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/plugin/Any23PluginManager.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/plugin/Any23PluginManager.java b/api/src/main/java/org/apache/any23/plugin/Any23PluginManager.java index 864d5d8..16ccc29 100644 --- a/api/src/main/java/org/apache/any23/plugin/Any23PluginManager.java +++ b/api/src/main/java/org/apache/any23/plugin/Any23PluginManager.java @@ -77,17 +77,17 @@ public class Any23PluginManager { private final DynamicClassLoader dynamicClassLoader; /** - * @return a singleton instance of {@link Any23PluginManager}. + * Constructor. */ - public static synchronized Any23PluginManager getInstance() { - return instance; + private Any23PluginManager() { + dynamicClassLoader = new DynamicClassLoader(); } /** - * Constructor. + * @return a singleton instance of {@link Any23PluginManager}. */ - private Any23PluginManager() { - dynamicClassLoader = new DynamicClassLoader(); + public static synchronized Any23PluginManager getInstance() { + return instance; } /** @@ -96,10 +96,11 @@ public class Any23PluginManager { * @param jar the JAR file to be loaded. * @return <code>true</code> if the JAR is added for the first time to the classpath, * <code>false</code> otherwise. - * @throws MalformedURLException */ public synchronized boolean loadJAR(File jar) { - if(jar == null) throw new NullPointerException("jar file cannot be null."); + if(jar == null) { + throw new NullPointerException("jar file cannot be null."); + } if (!jar.isFile() && !jar.exists()) { throw new IllegalArgumentException( String.format("Invalid JAR [%s], must be an existing file.", jar.getAbsolutePath()) @@ -139,7 +140,9 @@ public class Any23PluginManager { * <code>false</code> otherwise. */ public synchronized boolean loadClassDir(File classDir) { - if(classDir == null) throw new NullPointerException("classDir cannot be null."); + if(classDir == null) { + throw new NullPointerException("classDir cannot be null."); + } if (!classDir.isDirectory() && !classDir.exists()) { throw new IllegalArgumentException( String.format("Invalid class dir [%s], must be an existing file.", classDir.getAbsolutePath()) @@ -234,8 +237,9 @@ public class Any23PluginManager { * started with) and the dynamic classpath (the one specified using the load methods). * * @param <T> type of filtered class. + * @param type of filtered class. * @return list of matching classes. - * @throws IOException + * @throws IOException if there is an error obtaining plugins. */ public synchronized <T> Iterator<T> getPlugins(final Class<T> type) throws IOException { @@ -246,7 +250,8 @@ public class Any23PluginManager { * Returns the list of all the {@link Tool} classes declared within the classpath. * * @return not <code>null</code> list of tool classes. - * @throws IOException + * @throws IOException if there is an error obtaining {@link org.apache.any23.cli.Tool}'s + * from the classpath. */ public synchronized Iterator<Tool> getTools() throws IOException { return getPlugins(Tool.class); @@ -256,7 +261,7 @@ public class Any23PluginManager { * List of {@link ExtractorPlugin} classes declared within the classpath. * * @return not <code>null</code> list of plugin classes. - * @throws IOException + * @throws IOException if there is an error obtaining Extractors. */ public synchronized Iterator<ExtractorFactory> getExtractors() throws IOException { return getPlugins(ExtractorFactory.class); @@ -292,17 +297,15 @@ public class Any23PluginManager { * Configures a new list of extractors containing the extractors declared in <code>initialExtractorGroup</code> * and also the extractors detected in classpath specified by <code>pluginLocations</code>. * - * @param pluginLocations + * @param pluginLocations path locations of plugins. * @return full list of extractors. - * @throws java.io.IOException - * @throws IllegalAccessException - * @throws InstantiationException + * @throws java.io.IOException if there is an error locating the plugin(s). + * @throws IllegalAccessException if there are access permissions for plugin(s). + * @throws InstantiationException if there is an error instantiating plugin(s). */ public synchronized ExtractorGroup configureExtractors( - //final ExtractorGroup initialExtractorGroup, final File... pluginLocations ) throws IOException, IllegalAccessException, InstantiationException { - //if (initialExtractorGroup == null) throw new NullPointerException("inExtractorGroup cannot be null"); final String pluginsReport = loadPlugins(pluginLocations); logger.info(pluginsReport); @@ -323,10 +326,6 @@ public class Any23PluginManager { report.append("\n=== No plugins have been found.===\n"); } - //for (ExtractorFactory<?> extractorFactory : initialExtractorGroup) { - // newFactoryList.add(extractorFactory); - //} - return new ExtractorGroup(newFactoryList); } finally { logger.info(report.toString()); @@ -339,9 +338,9 @@ public class Any23PluginManager { * * @param initialExtractorGroup initial list of extractors. * @return full list of extractors. - * @throws IOException - * @throws InstantiationException - * @throws IllegalAccessException + * @throws java.io.IOException if there is an error locating the extractor(s). + * @throws IllegalAccessException if there are access permissions for extractor(s). + * @throws InstantiationException if there is an error instantiating extractor(s). */ public synchronized ExtractorGroup configureExtractors(ExtractorGroup initialExtractorGroup) throws IOException, InstantiationException, IllegalAccessException { @@ -357,9 +356,9 @@ public class Any23PluginManager { * @param pluginLocations optional list of plugin locations. * * @return a not <code>null</code> and not empty extractor group. - * @throws java.io.IOException - * @throws IllegalAccessException - * @throws InstantiationException + * @throws java.io.IOException if there is an error locating the extractor group. + * @throws IllegalAccessException if there are access permissions for the extractor group. + * @throws InstantiationException if there is an error instantiating the extractor group. */ public synchronized ExtractorGroup getApplicableExtractors(ExtractorRegistry registry, File... pluginLocations) throws IOException, IllegalAccessException, InstantiationException { @@ -371,7 +370,7 @@ public class Any23PluginManager { * * @param pluginLocations list of plugin locations. * @return set of detected tools. - * @throws IOException + * @throws IOException if there is an error acessing {@link org.apache.any23.cli.Tool}'s. */ public synchronized Iterator<Tool> getApplicableTools(File... pluginLocations) throws IOException { final String report = loadPlugins(pluginLocations); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/plugin/ExtractorPlugin.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/plugin/ExtractorPlugin.java b/api/src/main/java/org/apache/any23/plugin/ExtractorPlugin.java index d5970d2..7c6d5c5 100644 --- a/api/src/main/java/org/apache/any23/plugin/ExtractorPlugin.java +++ b/api/src/main/java/org/apache/any23/plugin/ExtractorPlugin.java @@ -21,8 +21,8 @@ import org.apache.any23.extractor.Extractor; import org.apache.any23.extractor.ExtractorFactory; /** - * This interface defines an {@link org.apache.any23.cli.Any23} - * extractor plugin that can be detected and registered from the library classpath. + * This interface defines an Any23 extractor plugin that can be + * detected and registered from the library classpath. * * @author Michele Mostarda ([email protected]) * @deprecated ExtractorFactory now supports META-INF/services discovery, deprecating this class. http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/source/DocumentSource.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/source/DocumentSource.java b/api/src/main/java/org/apache/any23/source/DocumentSource.java index ae88fd0..7c180a3 100644 --- a/api/src/main/java/org/apache/any23/source/DocumentSource.java +++ b/api/src/main/java/org/apache/any23/source/DocumentSource.java @@ -33,7 +33,8 @@ public interface DocumentSource { * Returns the input stream for accessing the content of the document. * * @return not <code>null</code> input stream for accessing document data. - * @throws IOException + * @throws IOException if there is an error opening the + * {@link org.apache.any23.source.DocumentSource} {@link java.io.InputStream} */ InputStream openInputStream() throws IOException; @@ -58,6 +59,8 @@ public interface DocumentSource { * to it should be avoided by copying it to local storage. * This can also be used for sources that do not support * multiple calls to {@link #openInputStream()}. + * @return true if the {@link org.apache.any23.source.DocumentSource} is + * cached locally. */ public boolean isLocal(); } http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/CSV.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/CSV.java b/api/src/main/java/org/apache/any23/vocab/CSV.java index ca713b0..180d1e6 100644 --- a/api/src/main/java/org/apache/any23/vocab/CSV.java +++ b/api/src/main/java/org/apache/any23/vocab/CSV.java @@ -68,7 +68,7 @@ public class CSV extends Vocabulary { /** * This property expresses the index of a column in a <i>CSV</i> file. */ - public URI columnPosition = createProperty(COLUMN_POSITION); + public final URI columnPosition = createProperty(COLUMN_POSITION); /** * The namespace of the vocabulary as a string. @@ -77,6 +77,10 @@ public class CSV extends Vocabulary { private static CSV instance; + private CSV() { + super(NS); + } + public static CSV getInstance() { if (instance == null) { instance = new CSV(); @@ -90,15 +94,11 @@ public class CSV extends Vocabulary { /** * - * @param localName + * @param localName name to assign to namespace. * @return the new URI instance. */ public URI createProperty(String localName) { return createProperty(NS, localName); } - private CSV() { - super(NS); - } - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/DCTerms.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/DCTerms.java b/api/src/main/java/org/apache/any23/vocab/DCTerms.java index c3e46c7..5e1fffc 100644 --- a/api/src/main/java/org/apache/any23/vocab/DCTerms.java +++ b/api/src/main/java/org/apache/any23/vocab/DCTerms.java @@ -20,22 +20,13 @@ package org.apache.any23.vocab; import org.openrdf.model.URI; /** - * The <i>DCTERMS</code> vocabulary. + * The <i>DCTERMS</i> vocabulary. * See <a href="http://dublincore.org/";>Dublin Core</a>. */ public class DCTerms extends Vocabulary { public static final String NS = "http://purl.org/dc/terms/";; - private static DCTerms instance; - - public static DCTerms getInstance() { - if(instance == null) { - instance = new DCTerms(); - } - return instance; - } - // Properties public final URI license = createProperty(NS, "license"); public final URI title = createProperty(NS, "title" ); @@ -43,8 +34,17 @@ public class DCTerms extends Vocabulary { public final URI related = createProperty(NS, "related"); public final URI date = createProperty(NS, "date" ); public final URI source = createProperty(NS, "source" ); + + private static DCTerms instance; private DCTerms(){ - super(NS); + super(NS); + } + + public static DCTerms getInstance() { + if(instance == null) { + instance = new DCTerms(); + } + return instance; } } http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/LKIFCoreRules.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/LKIFCoreRules.java b/api/src/main/java/org/apache/any23/vocab/LKIFCoreRules.java index 6ff7b4a..bae6534 100644 --- a/api/src/main/java/org/apache/any23/vocab/LKIFCoreRules.java +++ b/api/src/main/java/org/apache/any23/vocab/LKIFCoreRules.java @@ -24,7 +24,7 @@ import org.openrdf.model.URI; * The library consists of 15 modules, each of which describes a set of closely * related concepts from both legal and commonsense domains.</p> * - * <p>The rules & argumentation module defines roles central to + * <p>The rules & argumentation module defines roles central to * argumentation, and describes the vocabulary for LKIF rules * as defined in Deliverable 1.1, chapter 5. The module * leaves room for further extension to complex argumentation http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/OGP.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/OGP.java b/api/src/main/java/org/apache/any23/vocab/OGP.java index 87c30fe..7b3f159 100644 --- a/api/src/main/java/org/apache/any23/vocab/OGP.java +++ b/api/src/main/java/org/apache/any23/vocab/OGP.java @@ -20,7 +20,7 @@ package org.apache.any23.vocab; import org.openrdf.model.URI; /** - * The <a href="http://ogp.me/";>Open Graph Protocol</> vocabulary. + * The <a href="http://ogp.me/";>Open Graph Protocol</a> vocabulary. * * @author Michele Mostarda ([email protected]) */ http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/Programme.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/Programme.java b/api/src/main/java/org/apache/any23/vocab/Programme.java index 9e2a200..1a599e2 100644 --- a/api/src/main/java/org/apache/any23/vocab/Programme.java +++ b/api/src/main/java/org/apache/any23/vocab/Programme.java @@ -19,9 +19,9 @@ package org.apache.any23.vocab; import org.openrdf.model.URI; /** - * The <a href="http://purl.org/ontology/po/ ">Programmes Ontology</a> is aimed + * <p>The <a href="http://purl.org/ontology/po/";>Programmes Ontology</a> is aimed * at providing a simple vocabulary for describing programmes.</p> - * It covers brands, series (seasons), episodes, broadcast events, broadcast + * <p>It covers brands, series (seasons), episodes, broadcast events, broadcast * services, etc. Its development was funded by the BBC, and is heavily grounded * on previous programmes data modeling work done there.</p> * http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/vocab/WO.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/vocab/WO.java b/api/src/main/java/org/apache/any23/vocab/WO.java index 9f6f1ec..49d8a35 100644 --- a/api/src/main/java/org/apache/any23/vocab/WO.java +++ b/api/src/main/java/org/apache/any23/vocab/WO.java @@ -20,7 +20,7 @@ package org.apache.any23.vocab; import org.openrdf.model.URI; /** - * The <a href="http://purl.org/ontology/wo/";>Wildlife Ontology</a> vocabulary.</p> + * <p>The <a href="http://purl.org/ontology/wo/";>Wildlife Ontology</a> vocabulary.</p> * A simple vocabulary for describing biological species and related taxa. * The vocabulary defines terms for describing the names and ranking of taxa, * as well as providing support for describing their habitats, conservation status, http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/api/src/main/java/org/apache/any23/writer/TripleHandler.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/any23/writer/TripleHandler.java b/api/src/main/java/org/apache/any23/writer/TripleHandler.java index 9056466..c5b80e5 100644 --- a/api/src/main/java/org/apache/any23/writer/TripleHandler.java +++ b/api/src/main/java/org/apache/any23/writer/TripleHandler.java @@ -33,6 +33,9 @@ public interface TripleHandler { * Informs the handler that a new context has been established. * Contexts are not guaranteed to receive any triples, so they * might be closed without any triple. + * @param context an instantiated {@link org.apache.any23.extractor.ExtractionContext} + * @throws TripleHandlerException if there is an errr opening the + * {@link org.apache.any23.extractor.ExtractionContext} */ void openContext(ExtractionContext context) throws TripleHandlerException; @@ -45,7 +48,7 @@ public interface TripleHandler { * @param o triple object, cannot be <code>null</code>. * @param g triple graph, can be <code>null</code>. * @param context extraction context. - * @throws TripleHandlerException + * @throws TripleHandlerException if there is an error receiving the triple. */ void receiveTriple(Resource s, URI p, Value o, URI g, ExtractionContext context) throws TripleHandlerException; @@ -56,7 +59,7 @@ public interface TripleHandler { * @param prefix namespace prefix. * @param uri namespace <i>URI</i>. * @param context namespace context. - * @throws TripleHandlerException + * @throws TripleHandlerException if there is an error receiving the namespace. */ void receiveNamespace(String prefix, String uri, ExtractionContext context) throws TripleHandlerException; @@ -68,7 +71,8 @@ public interface TripleHandler { * local contexts of that document. * * @param context the context to be closed. - * @throws TripleHandlerException + * @throws TripleHandlerException if there is an error closing the + * {@link org.apache.any23.extractor.ExtractionContext}. */ void closeContext(ExtractionContext context) throws TripleHandlerException; @@ -77,21 +81,21 @@ public interface TripleHandler { * has been reached. * * @param documentURI document URI. - * @throws TripleHandlerException + * @throws TripleHandlerException if there is an error ending the document. */ void endDocument(URI documentURI) throws TripleHandlerException; /** * Sets the length of the content to be processed. * - * @param contentLength - * @throws TripleHandlerException + * @param contentLength length of the content being processed. */ void setContentLength(long contentLength); /** * Will be called last and exactly once. - * @throws TripleHandlerException + * @throws TripleHandlerException if there is an error closing the + * {@link org.apache.any23.writer.TripleHandler} implementation. */ void close() throws TripleHandlerException; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/Any23.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/Any23.java b/core/src/main/java/org/apache/any23/Any23.java index abd596c..7364668 100644 --- a/core/src/main/java/org/apache/any23/Any23.java +++ b/core/src/main/java/org/apache/any23/Any23.java @@ -123,6 +123,7 @@ public class Any23 { * Constructor that allows the specification of a * custom configuration and of list of extractor names. * + * @param configuration a {@link Configuration} object * @param extractorNames list of extractor's names. */ public Any23(Configuration configuration, String... extractorNames) { @@ -147,6 +148,7 @@ public class Any23 { /** * Constructor accepting {@link Configuration}. + * @param configuration a {@link Configuration} object */ public Any23(Configuration configuration) { this(configuration, (String[]) null); @@ -282,8 +284,8 @@ public class Any23 { * @param encoding explicit encoding see * <a href="http://www.iana.org/assignments/character-sets";>available encodings</a>. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws org.apache.any23.extractor.ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract( ExtractionParameters eps, @@ -317,8 +319,8 @@ public class Any23 { * @param encoding declared data encoding. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract( String in, @@ -339,8 +341,8 @@ public class Any23 { * @param documentURI URI from which the raw data has been extracted. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(String in, String documentURI, TripleHandler outputHandler) throws IOException, ExtractionException { @@ -354,8 +356,8 @@ public class Any23 { * @param file file containing raw data. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(File file, TripleHandler outputHandler) throws IOException, ExtractionException { @@ -371,8 +373,8 @@ public class Any23 { * @param documentURI the URI from which retrieve document. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(ExtractionParameters eps, String documentURI, TripleHandler outputHandler) throws IOException, ExtractionException { @@ -391,8 +393,8 @@ public class Any23 { * @param documentURI the URI from which retrieve document. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(String documentURI, TripleHandler outputHandler) throws IOException, ExtractionException { @@ -409,8 +411,8 @@ public class Any23 { * @param encoding explicit encoding see * <a href="http://www.iana.org/assignments/character-sets";>available encodings</a>. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(DocumentSource in, TripleHandler outputHandler, String encoding) throws IOException, ExtractionException { @@ -425,8 +427,8 @@ public class Any23 { * @param in the input document source. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(DocumentSource in, TripleHandler outputHandler) throws IOException, ExtractionException { @@ -442,8 +444,8 @@ public class Any23 { * @param in the input document source. * @param outputHandler handler responsible for collecting of the extracted metadata. * @return <code>true</code> if some extraction occurred, <code>false</code> otherwise. - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading the {@link org.apache.any23.source.DocumentSource} + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction */ public ExtractionReport extract(ExtractionParameters eps, DocumentSource in, TripleHandler outputHandler) throws IOException, ExtractionException { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/cli/ExtractorDocumentation.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/cli/ExtractorDocumentation.java b/core/src/main/java/org/apache/any23/cli/ExtractorDocumentation.java index eb5dd7e..9a0410b 100644 --- a/core/src/main/java/org/apache/any23/cli/ExtractorDocumentation.java +++ b/core/src/main/java/org/apache/any23/cli/ExtractorDocumentation.java @@ -86,6 +86,8 @@ public class ExtractorDocumentation implements Tool { /** * Prints the list of all the available extractors. + * @param registry the {@link org.apache.any23.extractor.ExtractorRegistry} + * containing all extractors */ public void printExtractorList(ExtractorRegistry registry) { for (ExtractorFactory factory : registry.getExtractorGroup()) { @@ -97,7 +99,8 @@ public class ExtractorDocumentation implements Tool { * Prints an example of input for the provided extractor. * * @param extractorName the name of the extractor - * @param registry + * @param registry the {@link org.apache.any23.extractor.ExtractorRegistry} + * containing all extractors * @throws IOException raised if no extractor is found with that name */ public void printExampleInput(String extractorName, ExtractorRegistry registry) throws IOException { @@ -114,9 +117,10 @@ public class ExtractorDocumentation implements Tool { * Prints an output example for the given extractor. * * @param extractorName the extractor name - * @param registry + * @param registry the {@link org.apache.any23.extractor.ExtractorRegistry} + * containing all extractors * @throws IOException raised if no extractor is found with that name - * @throws ExtractionException + * @throws ExtractionException if there is an error duing extraction */ public void printExampleOutput(String extractorName, ExtractorRegistry registry) throws IOException, ExtractionException { ExtractorFactory<?> factory = getFactory(registry, extractorName); @@ -131,8 +135,10 @@ public class ExtractorDocumentation implements Tool { /** * Prints a complete report on all the available extractors. * - * @throws IOException - * @throws ExtractionException + * @param registry the {@link org.apache.any23.extractor.ExtractorRegistry} + * containing all extractors + * @throws IOException raised if no extractor is found with that name + * @throws ExtractionException if there is an error duing extraction */ public void printReport(ExtractorRegistry registry) throws IOException, ExtractionException { for (String extractorName : registry.getAllNames()) { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/ExtractionResultImpl.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/ExtractionResultImpl.java b/core/src/main/java/org/apache/any23/extractor/ExtractionResultImpl.java index 2f0f960..c587ddc 100644 --- a/core/src/main/java/org/apache/any23/extractor/ExtractionResultImpl.java +++ b/core/src/main/java/org/apache/any23/extractor/ExtractionResultImpl.java @@ -35,19 +35,21 @@ import java.util.List; import java.util.Set; /** - * <p/> + * <p> * A default implementation of {@link ExtractionResult}; it receives * extraction output from one {@link Extractor} working on one document, * and passes the output on to a {@link TripleHandler}. It deals with * details such as creation of {@link ExtractionContext} objects * and closing any open contexts at the end of extraction. - * <p/> + * </p> + * <p> * The {@link #close()} method must be invoked after the extractor has * finished processing. - * <p/> + * </p> + * <p> * There is usually no need to provide additional implementations * of the ExtractionWriter interface. - * <p/> + *</p> * * @see org.apache.any23.writer.TripleHandler * @see ExtractionContext http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/ExtractorRegistryImpl.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/ExtractorRegistryImpl.java b/core/src/main/java/org/apache/any23/extractor/ExtractorRegistryImpl.java index 7213277..5175f8c 100644 --- a/core/src/main/java/org/apache/any23/extractor/ExtractorRegistryImpl.java +++ b/core/src/main/java/org/apache/any23/extractor/ExtractorRegistryImpl.java @@ -99,7 +99,7 @@ public class ExtractorRegistryImpl extends info.aduna.lang.service.ServiceRegist /** * Registers an {@link ExtractorFactory}. * - * @param factory + * @param factory the {@link org.apache.any23.extractor.ExtractorFactory} to register * @throws IllegalArgumentException if trying to register a {@link ExtractorFactory} * with a that already exists in the registry. */ http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/SingleDocumentExtraction.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/SingleDocumentExtraction.java b/core/src/main/java/org/apache/any23/extractor/SingleDocumentExtraction.java index e05c6b7..e496755 100644 --- a/core/src/main/java/org/apache/any23/extractor/SingleDocumentExtraction.java +++ b/core/src/main/java/org/apache/any23/extractor/SingleDocumentExtraction.java @@ -310,8 +310,8 @@ public class SingleDocumentExtraction { * Triggers the execution of all the {@link Extractor} * registered to this class using the <i>default</i> extraction parameters. * - * @throws IOException - * @throws ExtractionException + * @throws IOException if there is an error reading input from the document source + * @throws ExtractionException if there is an error duing distraction * @return the extraction report. */ public SingleDocumentExtractionReport run() throws IOException, ExtractionException { @@ -333,7 +333,7 @@ public class SingleDocumentExtraction { * Check whether the given {@link org.apache.any23.source.DocumentSource} content activates of not at least an extractor. * * @return <code>true</code> if at least an extractor is activated, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error locating matching extractors */ public boolean hasMatchingExtractors() throws IOException { filterExtractorsByMIMEType(); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/DomUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/DomUtils.java b/core/src/main/java/org/apache/any23/extractor/html/DomUtils.java index be27fda..72d824f 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/DomUtils.java +++ b/core/src/main/java/org/apache/any23/extractor/html/DomUtils.java @@ -54,11 +54,11 @@ import java.util.regex.Pattern; * It is separated from {@link HTMLDocument} so that its methods * can be run on single DOM nodes without having to wrap them * into an HTMLDocument. + * <p> * We use a mix of XPath and DOM manipulation. - * <p/> + * </p> * This is likely to be a performance bottleneck but at least * everything is localized here. - * <p/> */ public class DomUtils { @@ -230,6 +230,9 @@ public class DomUtils { /** * Mimics the JS DOM API, or prototype's $() + * @param root the node to locate + * @param id the id of the node to locate + * @return the {@link org.w3c.dom.Node} if one exists */ public static Node findNodeById(Node root, String id) { Node node; @@ -245,6 +248,9 @@ public class DomUtils { /** * Returns a NodeList composed of all the nodes that match an XPath * expression, which must be valid. + * @param node the node object to locate + * @param xpath an xpath expression + * @return a list of {@link org.w3c.dom.Node}'s if they exists */ public static List<Node> findAll(Node node, String xpath) { if(node == null) { @@ -264,6 +270,9 @@ public class DomUtils { /** * Gets the string value of an XPath expression. + * @param node the node object to locate + * @param xpath an xpath expression + * @return a string xpath value */ public static String find(Node node, String xpath) { try { @@ -279,6 +288,9 @@ public class DomUtils { /** * Tells if an element has a class name <b>not checking the parents * in the hierarchy</b> mimicking the <i>CSS</i> .foo match. + * @param node the node object to locate + * @param className the CSS class name + * @return true if the class name exists */ public static boolean hasClassName(Node node, String className) { return hasAttribute(node, "class", className); @@ -288,6 +300,10 @@ public class DomUtils { * Checks the presence of an attribute value in attributes that * contain whitespace-separated lists of values. The semantic is the * CSS classes' ones: "foo" matches "bar foo", "foo" but not "foob" + * @param node the node object to locate + * @param attributeName attribute value + * @param className the CSS class name + * @return true if the class has the attribute name */ public static boolean hasAttribute(Node node, String attributeName, String className) { // regex love, maybe faster but less easy to understand @@ -304,6 +320,7 @@ public class DomUtils { * * @param node the node container. * @param attributeName the name of the attribute. + * @return true if the attribute is present */ public static boolean hasAttribute(Node node, String attributeName) { return readAttribute(node, attributeName, null) != null; @@ -312,7 +329,7 @@ public class DomUtils { /** * Verifies if the given target node is an element. * - * @param target + * @param target target node to check * @return <code>true</code> if the element the node is an element, * <code>false</code> otherwise. */ @@ -384,7 +401,7 @@ public class DomUtils { * @return the XML serialization. * @throws TransformerException if an error occurs during the * serializator initialization and activation. - * @throws java.io.IOException + * @throws java.io.IOException if there is an error locating the node */ public static String serializeToXML(Node node, boolean indent) throws TransformerException, IOException { final DOMSource domSource = new DOMSource(node); @@ -410,7 +427,7 @@ public class DomUtils { * @param tagName name of target tag. * @param attrName name of attribute filter. * @param attrContains expected content for attribute. - * @return + * @return a {@link java.util.List} of {@link org.w3c.dom.Node}'s */ private static List<Node> findAllBy(Node root, final String tagName, final String attrName, String attrContains) { DocumentTraversal documentTraversal = (DocumentTraversal) root.getOwnerDocument(); @@ -501,9 +518,8 @@ public class DomUtils { /** * Convert a w3c dom node to a InputStream - * @param node - * @return - * @throws TransformerException + * @param node {@link org.w3c.dom.Node} to convert + * @return the converted {@link java.io.InputStream} */ public static InputStream nodeToInputStream(Node node) { ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); @@ -512,17 +528,14 @@ public class DomUtils { try { t = TransformerFactory.newInstance().newTransformer(); } catch (TransformerConfigurationException e) { - // TODO Auto-generated catch block e.printStackTrace(); } catch (TransformerFactoryConfigurationError e) { - // TODO Auto-generated catch block e.printStackTrace(); } t.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); try { t.transform(new DOMSource(node), outputTarget); } catch (TransformerException e) { - // TODO Auto-generated catch block e.printStackTrace(); } return new ByteArrayInputStream(outputStream.toByteArray()); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/EntityBasedMicroformatExtractor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/EntityBasedMicroformatExtractor.java b/core/src/main/java/org/apache/any23/extractor/html/EntityBasedMicroformatExtractor.java index 5aa0183..10e6872 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/EntityBasedMicroformatExtractor.java +++ b/core/src/main/java/org/apache/any23/extractor/html/EntityBasedMicroformatExtractor.java @@ -50,7 +50,7 @@ public abstract class EntityBasedMicroformatExtractor extends MicroformatExtract * @param node the DOM node. * @param out the extraction result collector. * @return <code>true</code> if the extraction has produces something, <code>false</code> otherwise. - * @throws ExtractionException + * @throws ExtractionException if there is an error during extraction */ protected abstract boolean extractEntity(Node node, ExtractionResult out) throws ExtractionException; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/HTMLDocument.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/HTMLDocument.java b/core/src/main/java/org/apache/any23/extractor/html/HTMLDocument.java index fe584d1..bdb9cdf 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/HTMLDocument.java +++ b/core/src/main/java/org/apache/any23/extractor/html/HTMLDocument.java @@ -96,8 +96,9 @@ public class HTMLDocument { /** * Reads an URL field from the given node adding the content to the given <i>res</i> list. * - * @param res - * @param node + * @param res {@link java.util.List} of + * {@link org.apache.any23.extractor.html.HTMLDocument.TextField} + * @param node the node to read */ public static void readUrlField(List<TextField> res, Node node) { String name = node.getNodeName(); @@ -169,7 +170,7 @@ public class HTMLDocument { /** * Constructor accepting the root node. * - * @param document + * @param document a {@link org.w3c.dom.Node} */ public HTMLDocument(Node document) { if (null == document) @@ -178,6 +179,7 @@ public class HTMLDocument { } /** + * @param uri string to resolve to {@link org.openrdf.model.URI} * @return An absolute URI, or null if the URI is not fixable * @throws org.apache.any23.extractor.ExtractionException If the base URI is invalid */ http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/LicenseExtractor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/LicenseExtractor.java b/core/src/main/java/org/apache/any23/extractor/html/LicenseExtractor.java index 2bd56fc..9e0dfa7 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/LicenseExtractor.java +++ b/core/src/main/java/org/apache/any23/extractor/html/LicenseExtractor.java @@ -34,7 +34,6 @@ import java.io.IOException; /** * Extractor for the <a href="http://microformats.org/wiki/rel-license";>rel-license</a> * microformat. - * <p/> * * @author Gabriele Renzi * @author Richard Cyganiak http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java b/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java index 4de6e21..31cbeb6 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java +++ b/core/src/main/java/org/apache/any23/extractor/html/MicroformatExtractor.java @@ -67,9 +67,11 @@ public abstract class MicroformatExtractor implements TagSoupDOMExtractor { /** * Performs the extraction of the data and writes them to the model. * The nodes generated in the model can have any name or implicit label - * but if possible they </i>SHOULD</i> have names (either URIs or AnonId) that + * but if possible they <i>SHOULD</i> have names (either URIs or AnonId) that * are uniquely derivable from their position in the DOM tree, so that * multiple extractors can merge information. + * @return true if extraction is successful + * @throws ExtractionException if there is an error during extraction */ protected abstract boolean extract() throws ExtractionException; @@ -218,9 +220,9 @@ public abstract class MicroformatExtractor implements TagSoupDOMExtractor { /** * Helper method that adds a URI property to a node. * - * @param subject - * @param property - * @param object + * @param subject subject to add + * @param property predicate to add + * @param object object to add */ protected void addURIProperty(Resource subject, URI property, URI object) { out.writeTriple(subject, property, object); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/SpeciesExtractor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/SpeciesExtractor.java b/core/src/main/java/org/apache/any23/extractor/html/SpeciesExtractor.java index d069243..0e9f51f 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/SpeciesExtractor.java +++ b/core/src/main/java/org/apache/any23/extractor/html/SpeciesExtractor.java @@ -84,7 +84,7 @@ public class SpeciesExtractor extends EntityBasedMicroformatExtractor { * @param node the DOM node. * @param out the extraction result collector. * @return <code>true</code> if the extraction has produces something, <code>false</code> otherwise. - * @throws org.apache.any23.extractor.ExtractionException + * @throws org.apache.any23.extractor.ExtractionException if there is an error during extraction * */ @Override http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/html/TagSoupParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/html/TagSoupParser.java b/core/src/main/java/org/apache/any23/extractor/html/TagSoupParser.java index 8e0acb6..50311bd 100644 --- a/core/src/main/java/org/apache/any23/extractor/html/TagSoupParser.java +++ b/core/src/main/java/org/apache/any23/extractor/html/TagSoupParser.java @@ -41,16 +41,16 @@ import java.nio.charset.Charset; import java.nio.charset.UnsupportedCharsetException; /** - * Parses an {@link java.io.InputStream} - * into an <io>HTML DOM</i> tree using a <i>TagSoup</i> parser. - * <p/> - * <strong>Note:</strong> The resulting <i>DOM</i> tree will not be namespace + * <p>Parses an {@link java.io.InputStream} + * into an <i>HTML DOM</i> tree using a <i>TagSoup</i> parser. + * </p> + * <p><strong>Note:</strong> The resulting <i>DOM</i> tree will not be namespace * aware, and all element names will be upper case, while attributes * will be lower case. This is because the * <a href="http://nekohtml.sourceforge.net/";>NekoHTML</a> based <i>TagSoup</i> parser * by default uses the <a href="http://xerces.apache.org/xerces2-j/dom.html";>Xerces HTML DOM</a> * implementation, which doesn't support namespaces and forces uppercase element names. This works - * with the <i>RDFa XSLT Converter</i> and with </i>XPath</i>, so we left it this way. + * with the <i>RDFa XSLT Converter</i> and with <i>XPath</i>, so we left it this way.</p> * * @author Richard Cyganiak (richard at cyganiak dot de) * @author Michele Mostarda ([email protected]) @@ -91,7 +91,7 @@ public class TagSoupParser { * Returns the DOM of the given document URI. * * @return the <i>HTML</i> DOM. - * @throws IOException + * @throws IOException if there is an error whilst accessing the DOM */ public Document getDOM() throws IOException { if (result == null) { @@ -123,12 +123,12 @@ public class TagSoupParser { * Returns the validated DOM and applies fixes on it if <i>applyFix</i> * is set to <code>true</code>. * - * @param applyFix + * @param applyFix whether to apply fixes to the DOM * @return a report containing the <i>HTML</i> DOM that has been validated and fixed if <i>applyFix</i> * if <code>true</code>. The reports contains also information about the activated rules and the * the detected issues. - * @throws IOException - * @throws org.apache.any23.validator.ValidatorException + * @throws IOException if there is an error accessing the DOM + * @throws org.apache.any23.validator.ValidatorException if there is an error validating the DOM */ public DocumentReport getValidatedDOM(boolean applyFix) throws IOException, ValidatorException { final URI dURI; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/microdata/ItemPropValue.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/microdata/ItemPropValue.java b/core/src/main/java/org/apache/any23/extractor/microdata/ItemPropValue.java index 5ba34cd..38b6e60 100644 --- a/core/src/main/java/org/apache/any23/extractor/microdata/ItemPropValue.java +++ b/core/src/main/java/org/apache/any23/extractor/microdata/ItemPropValue.java @@ -210,8 +210,6 @@ public class ItemPropValue { /** * @return the content value as URL, or raises an exception. - * @throws MalformedURLException if the content is not a valid URL. - * @throws ClassCastException if content is not a link. */ public URL getAsLink() { try { @@ -223,7 +221,6 @@ public class ItemPropValue { /** * @return the content value as {@link ItemScope}. - * @throws ClassCastException if the content is not a valid nested item. */ public ItemScope getAsNested() { return (ItemScope) content; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/microdata/ItemScope.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/microdata/ItemScope.java b/core/src/main/java/org/apache/any23/extractor/microdata/ItemScope.java index 6287eb3..5f817f5 100644 --- a/core/src/main/java/org/apache/any23/extractor/microdata/ItemScope.java +++ b/core/src/main/java/org/apache/any23/extractor/microdata/ItemScope.java @@ -63,10 +63,10 @@ public class ItemScope extends Item { * * @param xpath location of this <i>itemscope</i> within the container document. * @param itemProps list of properties bound to this <i>itemscope</i>. - * @param id DOM identifier for this <i>itemscope</i>. Can be <code>null<code>. - * @param refs list of item prop references connected to this <i>itemscope</i>. Can be <code>null<code>. - * @param type <i>itemscope</i> type. Can be <code>null<code>. - * @param itemId <i>itemscope</i> id. Can be <code>null<code>. + * @param id DOM identifier for this <i>itemscope</i>. Can be <code>null</code>. + * @param refs list of item prop references connected to this <i>itemscope</i>. Can be <code>null</code>. + * @param type <i>itemscope</i> type. Can be <code>null</code>. + * @param itemId <i>itemscope</i> id. Can be <code>null</code>. */ public ItemScope(String xpath, ItemProp[] itemProps, String id, String[] refs, String type, String itemId) { super(xpath); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java b/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java index 1bcacf6..7bb3ea0 100644 --- a/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java +++ b/core/src/main/java/org/apache/any23/extractor/microdata/MicrodataParser.java @@ -151,7 +151,7 @@ public class MicrodataParser { } /** - * Returns only the <i>itemScope<i>s that are top level items. + * Returns only the <i>itemScope</i>s that are top level items. * * @param node root node to search in. * @return list of detected top item scopes. @@ -214,7 +214,7 @@ public class MicrodataParser { * as described at <a href="http://www.w3.org/TR/microdata/#json";>Microdata JSON Specification</a>. * * @param document document to be processed. - * @param ps + * @param ps the {@link java.io.PrintStream} to write JSON to */ public static void getMicrodataAsJSON(Document document, PrintStream ps) { final MicrodataParserReport report = getMicrodata(document); @@ -298,7 +298,7 @@ public class MicrodataParser { } /** - * Reads the value of a <b>itemprop</code> node. + * Reads the value of a <b>itemprop</b> node. * * @param node itemprop node. * @return value detected within the given <code>node</code>. @@ -349,10 +349,10 @@ public class MicrodataParser { /** * Returns all the <b>itemprop</b>s for the given <b>itemscope</b> node. * - * @param scopeNode node representing the <b>itemscope</> - * @param skipRoot if <code>true</code> the given root <code>node</node> + * @param scopeNode node representing the <b>itemscope</b> + * @param skipRoot if <code>true</code> the given root <code>node</code> * will be not read as a property, even if it contains the <b>itemprop</b> attribute. - * @return the list of <b>itemprop<b>s detected within the given <b>itemscope</b>. + * @return the list of <b>itemprop</b>s detected within the given <b>itemscope</b>. * @throws MicrodataParserException if an error occurs while retrieving an property value. */ public List<ItemProp> getItemProps(final Node scopeNode, boolean skipRoot) throws MicrodataParserException { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/rdf/RDFParserFactory.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/rdf/RDFParserFactory.java b/core/src/main/java/org/apache/any23/extractor/rdf/RDFParserFactory.java index e24ceea..0ae85ec 100644 --- a/core/src/main/java/org/apache/any23/extractor/rdf/RDFParserFactory.java +++ b/core/src/main/java/org/apache/any23/extractor/rdf/RDFParserFactory.java @@ -203,7 +203,7 @@ public class RDFParserFactory { } /** - * Returns a new instance of a configured {@link SesameJSONLDParser}. + * Returns a new instance of a configured <i>SesameJSONLDParser</i>. * @param verifyDataType data verification enable if <code>true</code>. * @param stopAtFirstError the parser stops at first error if <code>true</code>. * @param extractionContext the extraction context where the parser is used. http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java b/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java index 0b9d885..4e45b73 100644 --- a/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java +++ b/core/src/main/java/org/apache/any23/extractor/rdfa/RDFa11Parser.java @@ -121,7 +121,7 @@ public class RDFa11Parser { * Given a prefix declaration returns a list of <code>prefixID:prefixURL</code> strings * normalizing blanks where present. * - * @param prefixesDeclaration + * @param prefixesDeclaration input prefix * @return list of extracted prefixes. */ protected static String[] extractPrefixSections(String prefixesDeclaration) { @@ -202,9 +202,10 @@ public class RDFa11Parser { /** * <a href="http://www.w3.org/TR/rdfa-syntax/#s_model";>RDFa Syntax - Processing Model</a>. * - * @param documentURL - * @param extractionResult - * @param document + * @param documentURL {@link java.net.URL} of the document to process + * @param extractionResult a {@link org.apache.any23.extractor.ExtractionResult} to populate + * @param document the {@link org.w3c.dom.Document} to populate with parse content + * @throws RDFa11ParserException if there is an error parsing the document */ public void processDocument(URL documentURL, Document document, ExtractionResult extractionResult) throws RDFa11ParserException { @@ -317,12 +318,12 @@ public class RDFa11Parser { } /** - * Resolves a <rm>whitelist</em> separated list of <i>CURIE</i> or <i>URI</i>. + * Resolves a <em>whitelist</em> separated list of <i>CURIE</i> or <i>URI</i>. * * @param n current node. * @param curieOrURIList list of CURIE/URI. * @return list of resolved URIs. - * @throws URISyntaxException + * @throws URISyntaxException if there is an error processing CURIE or URL */ protected URI[] resolveCurieOrURIList(Node n, String curieOrURIList, boolean termAllowed) throws URISyntaxException { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/xpath/QuadTemplate.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/xpath/QuadTemplate.java b/core/src/main/java/org/apache/any23/extractor/xpath/QuadTemplate.java index 41a69cd..57a7b68 100644 --- a/core/src/main/java/org/apache/any23/extractor/xpath/QuadTemplate.java +++ b/core/src/main/java/org/apache/any23/extractor/xpath/QuadTemplate.java @@ -71,9 +71,9 @@ public class QuadTemplate { /** * Constructor for template with no graph. * - * @param subject - * @param predicate - * @param object + * @param subject a populated {@link org.apache.any23.extractor.xpath.TemplateSubject} + * @param predicate a populated {@link org.apache.any23.extractor.xpath.TemplatePredicate} + * @param object a populated {@link org.apache.any23.extractor.xpath.TemplateObject} */ public QuadTemplate(TemplateSubject subject, TemplatePredicate predicate, TemplateObject object) { this(subject, predicate, object, null); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/extractor/xpath/TemplateXPathExtractionRule.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/extractor/xpath/TemplateXPathExtractionRule.java b/core/src/main/java/org/apache/any23/extractor/xpath/TemplateXPathExtractionRule.java index 6a5b610..8f0e41a 100644 --- a/core/src/main/java/org/apache/any23/extractor/xpath/TemplateXPathExtractionRule.java +++ b/core/src/main/java/org/apache/any23/extractor/xpath/TemplateXPathExtractionRule.java @@ -42,7 +42,7 @@ public interface TemplateXPathExtractionRule extends XPathExtractionRule { * Removes a variable from the template. * * @param variable variable to be removed. - * @return <code>true</i> if the <code>variable</code> argument was found. + * @return <i>true</i> if the <code>variable</code> argument was found. */ public boolean remove(Variable variable); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/http/AcceptHeaderBuilder.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/http/AcceptHeaderBuilder.java b/core/src/main/java/org/apache/any23/http/AcceptHeaderBuilder.java index efebca5..5f11537 100644 --- a/core/src/main/java/org/apache/any23/http/AcceptHeaderBuilder.java +++ b/core/src/main/java/org/apache/any23/http/AcceptHeaderBuilder.java @@ -60,8 +60,7 @@ public class AcceptHeaderBuilder { /** * Builds and returns an accept header. - * - * @throws IllegalArgumentException if an input MIME type cannot be parsed. + * @return the accept header. */ public String getAcceptHeader() { if (mimeTypes.isEmpty()) return null; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/http/DefaultHTTPClient.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/http/DefaultHTTPClient.java b/core/src/main/java/org/apache/any23/http/DefaultHTTPClient.java index f533040..c148009 100644 --- a/core/src/main/java/org/apache/any23/http/DefaultHTTPClient.java +++ b/core/src/main/java/org/apache/any23/http/DefaultHTTPClient.java @@ -58,7 +58,7 @@ public class DefaultHTTPClient implements HTTPClient { /** * Creates a {@link DefaultHTTPClient} instance already initialized * - * @return + * @return populated {@link org.apache.any23.http.DefaultHTTPClient} */ public static DefaultHTTPClient createInitializedHTTPClient() { final DefaultHTTPClient defaultHTTPClient = new DefaultHTTPClient(); @@ -78,7 +78,8 @@ public class DefaultHTTPClient implements HTTPClient { * * @param uri to be opened * @return {@link java.io.InputStream} - * @throws IOException + * @throws IOException if there is an error opening the {@link java.io.InputStream} + * located at the URI. */ public InputStream openInputStream(String uri) throws IOException { GetMethod method = null; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/http/DefaultHTTPClientConfiguration.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/http/DefaultHTTPClientConfiguration.java b/core/src/main/java/org/apache/any23/http/DefaultHTTPClientConfiguration.java index b0e9aa3..794162e 100644 --- a/core/src/main/java/org/apache/any23/http/DefaultHTTPClientConfiguration.java +++ b/core/src/main/java/org/apache/any23/http/DefaultHTTPClientConfiguration.java @@ -44,8 +44,8 @@ public class DefaultHTTPClientConfiguration implements HTTPClientConfiguration { * Constructor. * * @param userAgent the user agent descriptor string. - * @param defaultTimeout the default timeout, cannot be <code><&eq to 0</code> - * @param maxConnections the default max connections, cannot be <code><&eq to 0</code> + * @param defaultTimeout the default timeout, cannot be <code><= to 0</code> + * @param maxConnections the default max connections, cannot be <code><= to 0</code> * @param acceptHeader the accept header string, can be <code>null</code>. */ public DefaultHTTPClientConfiguration( @@ -77,7 +77,7 @@ public class DefaultHTTPClientConfiguration implements HTTPClientConfiguration { /** * Constructor. - * initialized with default {@link DefaultConfiguration} parameters and <code>acceptHeader=null</>. + * initialized with default {@link DefaultConfiguration} parameters and <code>acceptHeader=null</code>. */ public DefaultHTTPClientConfiguration() { this(null); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/rdf/Any23ValueFactoryWrapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/rdf/Any23ValueFactoryWrapper.java b/core/src/main/java/org/apache/any23/rdf/Any23ValueFactoryWrapper.java index d601d68..0f93151 100644 --- a/core/src/main/java/org/apache/any23/rdf/Any23ValueFactoryWrapper.java +++ b/core/src/main/java/org/apache/any23/rdf/Any23ValueFactoryWrapper.java @@ -27,7 +27,6 @@ import org.openrdf.model.Statement; import org.openrdf.model.URI; import org.openrdf.model.Value; import org.openrdf.model.ValueFactory; -import org.openrdf.model.impl.ValueFactoryBase; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -162,7 +161,7 @@ public class Any23ValueFactoryWrapper implements ValueFactory { } /** - * @param uriStr + * @param uriStr input string to create URI from. * @return a valid sesame URI or null if any exception occurred */ public URI createURI(String uriStr) { @@ -200,7 +199,7 @@ public class Any23ValueFactoryWrapper implements ValueFactory { } /** - * @param uri + * @param uri input string to attempt fix on. * @return a valid sesame URI or null if any exception occurred */ public URI fixURI(String uri) { @@ -214,6 +213,9 @@ public class Any23ValueFactoryWrapper implements ValueFactory { /** * Helper method to conditionally add a schema to a URI unless it's there, or null if link is empty. + * @param link string representation of the URI + * @param defaultSchema schema to add the URI + * @return a valid {@link org.openrdf.model.URI} */ public URI fixLink(String link, String defaultSchema) { if (link == null) return null;
