[
https://issues.apache.org/jira/browse/LUCENE-4565?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13511331#comment-13511331
]
Gilad Barkai commented on LUCENE-4565:
--------------------------------------
bq. I thought that it's over-verbosing to put them in the method names. Rather,
I think that good javadocs are what's needed here. It's an API that one reads
one time usually.
{{.children()}} looks like it's getting all children, it does not.
{{.siblings()}} looks like it returns all siblings, which it does not. I think
a good JavaDoc is a blessing, but it's not a penalty in making the code
document itself - which it did till now. I see no reason to change that.
bq. They are reused
My bad! I need coffee...
> Simplify TaxoReader ParentArray/ChildrenArrays
> ----------------------------------------------
>
> Key: LUCENE-4565
> URL: https://issues.apache.org/jira/browse/LUCENE-4565
> Project: Lucene - Core
> Issue Type: Improvement
> Components: modules/facet
> Reporter: Shai Erera
> Assignee: Shai Erera
> Priority: Minor
> Attachments: LUCENE-4565.patch
>
>
> TaxoReader exposes two structures which provide information about a
> categories parent/childs/siblings: ParentArray and ChildrenArrays.
> ChildrenArrays are derived (i.e. created) from ParentArray.
> I propose to consolidate all that into one API ParentInfo, or
> CategoryTreeInfo (a better name?) which will provide the same information,
> only from one object. So instead of making these calls:
> {code}
> int[] parents = taxoReader.getParentArray();
> int[] youngestChilds = taxoReader.getChildrenArrays().getYoungestChildArray();
> int[] olderSiblings = taxoReader.getChildrenArrays().getOlderSiblingArray();
> {code}
> one would make these calls:
> {code}
> int[] parents = taxoReader.getParentInfo().parents();
> int[] youngestChilds = taxoReader.getParentInfo().youngestChilds();
> int[] olderSiblings = taxoReader.getParentInfo().olderSiblings();
> {code}
> Not a big change, just consolidate more code into one logical place. All of
> these arrays will continue to be lazily allocated.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
