You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by jo...@apache.org on 2004/03/17 22:21:56 UTC
cvs commit: cocoon-2.1/src/blocks/lucene/java/org/apache/cocoon/components/search LuceneIndexContentHandler.java
joerg 2004/03/17 13:21:56
Modified: src/blocks/lucene/java/org/apache/cocoon/components/search
LuceneIndexContentHandler.java
Log:
removed useless JavaDoc ('description of parameter/ method')
Revision Changes Path
1.6 +9 -110 cocoon-2.1/src/blocks/lucene/java/org/apache/cocoon/components/search/LuceneIndexContentHandler.java
Index: LuceneIndexContentHandler.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/lucene/java/org/apache/cocoon/components/search/LuceneIndexContentHandler.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- LuceneIndexContentHandler.java 6 Mar 2004 14:44:46 -0000 1.5
+++ LuceneIndexContentHandler.java 17 Mar 2004 21:21:55 -0000 1.6
@@ -43,9 +43,11 @@
{
public static final String LUCENE_URI = "http://apache.org/cocoon/lucene/1.0";
- /** If this attribute is specified on element, values of all attributes
- * if this element added to the text of the element, and to the document
- * body text */
+ /**
+ * If this attribute is specified on element, values of all attributes
+ * are added to the text of the element, and to the document
+ * body text
+ */
public static final String LUCENE_ATTR_TO_TEXT_ATTRIBUTE = "text-attr";
StringBuffer bodyText;
@@ -55,9 +57,7 @@
private HashSet fieldTags;
/**
- *Constructor for the LuceneIndexContentHandler object
- *
- * @since
+ * Constructor for the LuceneIndexContentHandler object
*/
public LuceneIndexContentHandler() {
this.bodyText = new StringBuffer();
@@ -69,56 +69,30 @@
}
/**
- *Sets the fieldTags attribute of the LuceneIndexContentHandler object
+ * Sets the fieldTags attribute of the LuceneIndexContentHandler object
*
* @param fieldTags The new fieldTags value
- * @since
*/
public void setFieldTags(HashSet fieldTags) {
this.fieldTags = fieldTags;
}
/**
- *Sets the documentLocator attribute of the LuceneIndexContentHandler object
+ * Sets the documentLocator attribute of the LuceneIndexContentHandler object
*
* @param locator The new documentLocator value
- * @since
*/
public void setDocumentLocator(Locator locator) { }
-
- /**
- *Description of the Method
- *
- * @return Description of the Returned Value
- * @since
- */
public List allDocuments() {
return documents;
}
-
- /**
- *Description of the Method
- *
- * @return Description of the Returned Value
- * @since
- */
public Iterator iterator() {
return documents.iterator();
}
-
- /**
- *Description of the Method
- *
- * @param ch Description of Parameter
- * @param start Description of Parameter
- * @param length Description of Parameter
- * @since
- */
public void characters(char[] ch, int start, int length) {
-
if (ch.length > 0 && start >= 0 && length > 1) {
if (elementStack.size() > 0) {
IndexHelperField tos = (IndexHelperField) elementStack.peek();
@@ -129,28 +103,10 @@
}
}
-
- /**
- *Description of the Method
- *
- * @since
- */
public void endDocument() {
- /*
- * empty
- */
bodyDocument.add(Field.UnStored(LuceneXMLIndexer.BODY_FIELD, bodyText.toString()));
}
-
- /**
- *Description of the Method
- *
- * @param namespaceURI Description of Parameter
- * @param localName Description of Parameter
- * @param qName Description of Parameter
- * @since
- */
public void endElement(String namespaceURI, String localName, String qName) {
IndexHelperField tos = (IndexHelperField) elementStack.pop();
String lname = tos.getLocalFieldName();
@@ -174,7 +130,6 @@
}
if (text != null && text.length() > 0) {
-
if (isFieldTag(lname)) {
bodyDocument.add(Field.UnIndexed(lname, text.toString()));
}
@@ -182,76 +137,21 @@
}
}
-
- /**
- *Description of the Method
- *
- * @param prefix Description of Parameter
- * @since
- */
public void endPrefixMapping(String prefix) { }
-
- /**
- *Description of the Method
- *
- * @param ch Description of Parameter
- * @param start Description of Parameter
- * @param length Description of Parameter
- * @since
- */
public void ignorableWhitespace(char[] ch, int start, int length) { }
-
- /**
- *Description of the Method
- *
- * @param target Description of Parameter
- * @param data Description of Parameter
- * @since
- */
public void processingInstruction(String target, String data) { }
-
- /**
- *Description of the Method
- *
- * @param name Description of Parameter
- * @since
- */
public void skippedEntity(String name) { }
-
- /**
- *Description of the Method
- *
- * @since
- */
public void startDocument() { }
-
- /**
- *Description of the Method
- *
- * @param namespaceURI Description of Parameter
- * @param localName Description of Parameter
- * @param qName Description of Parameter
- * @param atts Description of Parameter
- * @since
- */
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) {
IndexHelperField ihf = new IndexHelperField(localName, qName, new AttributesImpl(atts));
elementStack.push(ihf);
}
-
- /**
- *Description of the Method
- *
- * @param prefix Description of Parameter
- * @param uri Description of Parameter
- * @since
- */
public void startPrefixMapping(String prefix, String uri) { }
/**
@@ -259,7 +159,6 @@
*
* @param tag local name of the tag we are processing
* @return boolean
- * @since
*/
private boolean isFieldTag(String tag) {
// by default do not make field