You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Grant Ingersoll (JIRA)" <ji...@apache.org> on 2007/06/08 04:09:25 UTC

[jira] Created: (LUCENE-925) Analysis Package Level Javadocs

Analysis Package Level Javadocs
-------------------------------

                 Key: LUCENE-925
                 URL: https://issues.apache.org/jira/browse/LUCENE-925
             Project: Lucene - Java
          Issue Type: Wish
          Components: Javadocs
    Affects Versions: 2.2
            Reporter: Grant Ingersoll
            Priority: Minor


Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Commented: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12505374 ] 

Doron Cohen commented on LUCENE-925:
------------------------------------

Great, thanks for reviewing Michael!
I will commit then.

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Commented: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Grant Ingersoll (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12504402 ] 

Grant Ingersoll commented on LUCENE-925:
----------------------------------------

Looks good to me.
I will stand by my commitment to commit sometime tomorrow. 

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Reopened: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doron Cohen reopened LUCENE-925:
--------------------------------

         Assignee: Doron Cohen  (was: Grant Ingersoll)
    Lucene Fields: [Patch Available]

Later than I'd hoped, an extended analysis package doc.
Reopening this issue b/c can't attache a file without re-opening.


> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doron Cohen updated LUCENE-925:
-------------------------------

    Attachment: LUCENE-925.patch

Attached adds some code samples and adds these sections: 
- Invoking the Analyzer
- Indexing Analysis vs. Search Analysis
- - Field Section Boundaries
- - Token Position Increments

As today is the last day to commit javadoc issues I am hoping for some quick feedback...


> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Assigned: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Grant Ingersoll (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Grant Ingersoll reassigned LUCENE-925:
--------------------------------------

    Assignee: Grant Ingersoll

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doron Cohen updated LUCENE-925:
-------------------------------

    Attachment: LUCENE-925.patch

Very concise, I like it!

I fixed two typos and added some more info/text (it is less concise now:-))

I am considering adding some further discussion of things like position-Increment, analysis at indexing vs. search, and some simple code snippets - hope to have that tomorrow.

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Resolved: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doron Cohen resolved LUCENE-925.
--------------------------------

    Resolution: Fixed

Committed to branch 2.2 and trunk  (btw removed few differences between trunk and branch 2.2 for this file).

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Grant Ingersoll (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Grant Ingersoll updated LUCENE-925:
-----------------------------------

    Attachment: LUCENE-925.patch

First crack at some Analysis level javadocs.  All comments welcome.  Could use a bit more on best practices, maybe, but has a good intro, I think, to the main concepts.

Please let me know of changes by 6/14/07, otherwise I will commit to branch and trunk.


> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doron Cohen updated LUCENE-925:
-------------------------------

    Attachment: LUCENE-925.patch

Looks good. 
I shortened the stemming "bikes"/"bike" example and moved it to the stemming bullet.


> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Closed: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Grant Ingersoll (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Grant Ingersoll closed LUCENE-925.
----------------------------------

       Resolution: Fixed
    Lucene Fields:   (was: [New])

Committed to branch 2.2 and trunk

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Commented: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12505367 ] 

Michael Busch commented on LUCENE-925:
--------------------------------------

Doron,

I read the new sections... really good stuff and definitely useful!
I also like that you added more Wikipedia links.

My +1 for committing.

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Doron Cohen
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Grant Ingersoll (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Grant Ingersoll updated LUCENE-925:
-----------------------------------

    Attachment: LUCENE-925-GSI-v2.patch

I see your patch, Doron, and raise you one patch.

Added some info on stemming, etc. and a disclaimer about sentence breaking.



> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Assignee: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>         Attachments: LUCENE-925-GSI-v2.patch, LUCENE-925.patch, LUCENE-925.patch
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


[jira] Updated: (LUCENE-925) Analysis Package Level Javadocs

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-925?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Busch updated LUCENE-925:
---------------------------------

    Fix Version/s: 2.2

> Analysis Package Level Javadocs
> -------------------------------
>
>                 Key: LUCENE-925
>                 URL: https://issues.apache.org/jira/browse/LUCENE-925
>             Project: Lucene - Java
>          Issue Type: Wish
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Grant Ingersoll
>            Priority: Minor
>             Fix For: 2.2
>
>
> Analysis package level javadocs need improving.  An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful.  Bonus would be some discussion on best practices for achieving performance during analysis. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org