You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ko...@apache.org on 2010/12/11 03:24:13 UTC
svn commit: r1044562 - in /lucene/dev/branches/branch_3x: ./ lucene/ solr/
solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/
solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/
Author: koji
Date: Sat Dec 11 02:24:12 2010
New Revision: 1044562
URL: http://svn.apache.org/viewvc?rev=1044562&view=rev
Log:
javadoc for DIH
Modified:
lucene/dev/branches/branch_3x/ (props changed)
lucene/dev/branches/branch_3x/lucene/ (props changed)
lucene/dev/branches/branch_3x/solr/ (props changed)
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/MailEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/TikaEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ClobTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DateFormatTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DocBuilder.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorBase.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorWrapper.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Evaluator.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldStreamDataSource.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileDataSource.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LogTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/PlainTextEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/RegexTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ScriptTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/TemplateTransformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Transformer.java
lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/MailEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/MailEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/MailEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/MailEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -38,7 +38,7 @@ import java.text.SimpleDateFormat;
import java.util.*;
/**
- * An EntityProcessor instance which can index emails along with their attachments from POP3 or IMAP sources. Refer to
+ * An {@link EntityProcessor} instance which can index emails along with their attachments from POP3 or IMAP sources. Refer to
* <a href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a> for more
* details. <b>This API is experimental and subject to change</b>
*
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/TikaEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/TikaEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/TikaEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/extras/main/java/org/apache/solr/handler/dataimport/TikaEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -48,10 +48,11 @@ import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
/**
- * <p>An implementation of EntityProcessor which reads data from rich docs using Tika
+ * <p>An implementation of {@link EntityProcessor} which reads data from rich docs
+ * using <a href="http://tika.apache.org/">Apache Tika</a>
*
* @version $Id$
- * @since solr 1.5
+ * @since solr 3.1
*/
public class TikaEntityProcessor extends EntityProcessorBase {
private TikaConfig tikaConfig;
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ClobTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ClobTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ClobTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ClobTransformer.java Sat Dec 11 02:24:12 2010
@@ -26,7 +26,7 @@ import java.util.List;
import java.util.Map;
/**
- * Transformer instance which converts a Clob to a String.
+ * {@link Transformer} instance which converts a {@link Clob} to a {@link String}.
* <p/>
* Refer to <a href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a>
* for more details.
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DateFormatTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DateFormatTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DateFormatTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DateFormatTransformer.java Sat Dec 11 02:24:12 2010
@@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory;
/**
* <p>
- * Transformer instance which creates Date instances out of Strings.
+ * {@link Transformer} instance which creates {@link Date} instances out of {@link String}s.
* </p>
* <p/>
* <p>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DocBuilder.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DocBuilder.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DocBuilder.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/DocBuilder.java Sat Dec 11 02:24:12 2010
@@ -31,8 +31,8 @@ import java.util.concurrent.atomic.Atomi
import java.util.concurrent.*;
/**
- * <p> DocBuilder is responsible for creating Solr documents out of the given configuration. It also maintains
- * statistics information. It depends on the EntityProcessor implementations to fetch data. </p>
+ * <p> {@link DocBuilder} is responsible for creating Solr documents out of the given configuration. It also maintains
+ * statistics information. It depends on the {@link EntityProcessor} implementations to fetch data. </p>
* <p/>
* <b>This API is experimental and subject to change</b>
*
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorBase.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorBase.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorBase.java Sat Dec 11 02:24:12 2010
@@ -23,7 +23,7 @@ import org.slf4j.LoggerFactory;
import java.util.*;
/**
- * <p> Base class for all implementations of EntityProcessor </p> <p/> <p> Most implementations of EntityProcessor
+ * <p> Base class for all implementations of {@link EntityProcessor} </p> <p/> <p> Most implementations of {@link EntityProcessor}
* extend this base class which provides common functionality. </p>
* <p/>
* <b>This API is experimental and subject to change</b>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorWrapper.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorWrapper.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorWrapper.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/EntityProcessorWrapper.java Sat Dec 11 02:24:12 2010
@@ -29,7 +29,7 @@ import java.util.List;
import java.util.Map;
/**
- * A Wrapper over EntityProcessor instance which performs transforms and handles multi-row outputs correctly.
+ * A Wrapper over {@link EntityProcessor} instance which performs transforms and handles multi-row outputs correctly.
*
* @version $Id$
* @since solr 1.4
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Evaluator.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Evaluator.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Evaluator.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Evaluator.java Sat Dec 11 02:24:12 2010
@@ -36,9 +36,9 @@ package org.apache.solr.handler.dataimpo
public abstract class Evaluator {
/**
- * Return a String after processing an expression and a VariableResolver
+ * Return a String after processing an expression and a {@link VariableResolver}
*
- * @see org.apache.solr.handler.dataimport.VariableResolver
+ * @see VariableResolver
* @param expression string to be evaluated
* @param context instance
* @return the value of the given expression evaluated using the resolver
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java Sat Dec 11 02:24:12 2010
@@ -28,7 +28,7 @@ import java.sql.SQLException;
import java.util.Properties;
/**
- * This can be useful for users who have a DB field containing xml and wish to use a nested XPathEntityProcessor
+ * This can be useful for users who have a DB field containing xml and wish to use a nested {@link XPathEntityProcessor}
* <p/>
* The datasouce may be configured as follows
* <p/>
@@ -36,9 +36,9 @@ import java.util.Properties;
* <p/>
* The enity which uses this datasource must keep the url value as the variable name url="field-name"
* <p/>
- * The fieldname must be resolvable from VariableResolver
+ * The fieldname must be resolvable from {@link VariableResolver}
* <p/>
- * This may be used with any EntityProcessor which uses a DataSource<Reader> eg:XPathEntityProcessor
+ * This may be used with any {@link EntityProcessor} which uses a {@link DataSource}<{@link Reader}> eg: {@link XPathEntityProcessor}
* <p/>
* Supports String, BLOB, CLOB data types and there is an extra field (in the entity) 'encoding' for BLOB types
*
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldStreamDataSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldStreamDataSource.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldStreamDataSource.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FieldStreamDataSource.java Sat Dec 11 02:24:12 2010
@@ -38,13 +38,13 @@ import static org.apache.solr.handler.da
* <p/>
* The entity which uses this datasource must keep and attribute dataField
* <p/>
- * The fieldname must be resolvable from VariableResolver
+ * The fieldname must be resolvable from {@link VariableResolver}
* <p/>
- * This may be used with any EntityProcessor which uses a DataSource<InputStream> eg:TikaEntityProcessor
+ * This may be used with any {@link EntityProcessor} which uses a {@link DataSource}<{@link InputStream}> eg: {@link TikaEntityProcessor}
* <p/>
*
* @version $Id$
- * @since 1.5
+ * @since 3.1
*/
public class FieldStreamDataSource extends DataSource<InputStream> {
private static final Logger LOG = LoggerFactory.getLogger(FieldReaderDataSource.class);
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileDataSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileDataSource.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileDataSource.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileDataSource.java Sat Dec 11 02:24:12 2010
@@ -26,7 +26,7 @@ import static org.apache.solr.handler.da
/**
* <p>
- * A DataSource which reads from local files
+ * A {@link DataSource} which reads from local files
* </p>
* <p>
* The file is read with the default platform encoding. It can be overriden by
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -25,7 +25,7 @@ import java.util.regex.Pattern;
/**
* <p>
- * An EntityProcessor instance which can stream file names found in a given base
+ * An {@link EntityProcessor} instance which can stream file names found in a given base
* directory matching patterns and returning rows containing file information.
* </p>
* <p/>
@@ -38,7 +38,7 @@ import java.util.regex.Pattern;
* <li>size (bigger or smaller than size given in bytes)</li>
* <li>recursively iterating through sub-directories</li>
* </ul>
- * Its output can be used along with FileDataSource to read from files in file
+ * Its output can be used along with {@link FileDataSource} to read from files in file
* systems.
* </p>
* <p/>
@@ -52,6 +52,7 @@ import java.util.regex.Pattern;
*
* @version $Id$
* @since solr 1.3
+ * @see Pattern
*/
public class FileListEntityProcessor extends EntityProcessorBase {
/**
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java Sat Dec 11 02:24:12 2010
@@ -27,7 +27,7 @@ import java.util.List;
import java.util.Map;
/**
- * A Transformer implementation which strip off HTML tags using org.apache.solr.analysis.HTMLStripReader This is useful
+ * A {@link Transformer} implementation which strip off HTML tags using {@link HTMLStripCharFilter} This is useful
* in case you don't need this HTML anyway.
*
* @version $Id$
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -25,7 +25,7 @@ import org.apache.commons.io.IOUtils;
/**
* <p>
- * An EntityProcessor instance which can stream lines of text read from a
+ * An {@link EntityProcessor} instance which can stream lines of text read from a
* datasource. Options allow lines to be explicitly skipped or included in the index.
* </p>
* <p/>
@@ -54,6 +54,7 @@ import org.apache.commons.io.IOUtils;
*
* @version $Id$
* @since solr 1.4
+ * @see Pattern
*/
public class LineEntityProcessor extends EntityProcessorBase {
private Pattern acceptLineRegex, skipLineRegex;
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LogTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LogTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LogTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/LogTransformer.java Sat Dec 11 02:24:12 2010
@@ -22,7 +22,7 @@ import org.slf4j.LoggerFactory;
import java.util.Map;
/**
- * A Transformer implementation which logs messages in a given template format.
+ * A {@link Transformer} implementation which logs messages in a given template format.
* <p/>
* Refer to <a href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a>
* for more details.
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java Sat Dec 11 02:24:12 2010
@@ -28,10 +28,10 @@ import java.util.regex.Pattern;
/**
* <p>
- * A Transformer instance which can extract numbers out of strings. It uses
- * <code>java.text.NumberFormat</code> class to parse strings and supports
+ * A {@link Transformer} instance which can extract numbers out of strings. It uses
+ * {@link NumberFormat} class to parse strings and supports
* Number, Integer, Currency and Percent styles as supported by
- * <code>java.text.NumberFormat</code> with configurable locales.
+ * {@link NumberFormat} with configurable locales.
* </p>
* <p/>
* <p>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/PlainTextEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/PlainTextEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/PlainTextEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/PlainTextEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -30,7 +30,7 @@ import java.util.HashMap;
import java.util.Map;
/**
- * <p>An implementation of EntityProcessor which reads data from a url/file and give out a row which contains one String
+ * <p>An implementation of {@link EntityProcessor} which reads data from a url/file and give out a row which contains one String
* value. The name of the field is 'plainText'.
*
* @version $Id$
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/RegexTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/RegexTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/RegexTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/RegexTransformer.java Sat Dec 11 02:24:12 2010
@@ -24,7 +24,7 @@ import java.util.regex.Pattern;
/**
* <p>
- * A Transformer implementation which uses Regular Expressions to extract, split
+ * A {@link Transformer} implementation which uses Regular Expressions to extract, split
* and replace data in fields.
* </p>
* <p/>
@@ -38,6 +38,7 @@ import java.util.regex.Pattern;
*
* @version $Id$
* @since solr 1.3
+ * @see Pattern
*/
public class RegexTransformer extends Transformer {
private static final Logger LOG = LoggerFactory.getLogger(RegexTransformer.class);
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ScriptTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ScriptTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ScriptTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/ScriptTransformer.java Sat Dec 11 02:24:12 2010
@@ -25,8 +25,8 @@ import java.util.Map;
/**
* <p>
- * A Transformer instance capable of executing functions written in scripting
- * languages as a Transformer instance.
+ * A {@link Transformer} instance capable of executing functions written in scripting
+ * languages as a {@link Transformer} instance.
* </p>
* <p/>
* <p>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -25,9 +25,9 @@ import java.util.regex.Pattern;
/**
* <p>
- * An EntityProcessor instance which provides support for reading from
- * databases. It is used in conjunction with JdbcDataSource. This is the default
- * EntityProcessor if none is specified explicitly in data-config.xml
+ * An {@link EntityProcessor} instance which provides support for reading from
+ * databases. It is used in conjunction with {@link JdbcDataSource}. This is the default
+ * {@link EntityProcessor} if none is specified explicitly in data-config.xml
* </p>
* <p/>
* <p>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/TemplateTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/TemplateTransformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/TemplateTransformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/TemplateTransformer.java Sat Dec 11 02:24:12 2010
@@ -24,7 +24,7 @@ import org.slf4j.LoggerFactory;
/**
* <p>
- * A Transformer which can put values into a column by resolving an expression
+ * A {@link Transformer} which can put values into a column by resolving an expression
* containing other columns
* </p>
* <p/>
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Transformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Transformer.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Transformer.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/Transformer.java Sat Dec 11 02:24:12 2010
@@ -44,9 +44,9 @@ public abstract class Transformer {
*
* @param context The current context
* @param row A row of data
- * @return The changed data. It must be a Map<String, Object> if it returns
+ * @return The changed data. It must be a {@link Map}<{@link String}, {@link Object}> if it returns
* only one row or if there are multiple rows to be returned it must
- * be a List<Map<String, Object>>
+ * be a {@link java.util.List}<{@link Map}<{@link String}, {@link Object}>>
*/
public abstract Object transformRow(Map<String, Object> row, Context context);
}
Modified: lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java?rev=1044562&r1=1044561&r2=1044562&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java (original)
+++ lucene/dev/branches/branch_3x/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java Sat Dec 11 02:24:12 2010
@@ -37,8 +37,8 @@ import java.util.concurrent.atomic.Atomi
import java.util.concurrent.atomic.AtomicReference;
/**
- * <p> An implementation of EntityProcessor which uses a streaming xpath parser to extract values out of XML documents.
- * It is typically used in conjunction with HttpDataSource or FileDataSource. </p> <p/> <p> Refer to <a
+ * <p> An implementation of {@link EntityProcessor} which uses a streaming xpath parser to extract values out of XML documents.
+ * It is typically used in conjunction with {@link URLDataSource} or {@link FileDataSource}. </p> <p/> <p> Refer to <a
* href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a> for more
* details. </p>
* <p/>