jackrabbit-oak-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "angela (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OAK-221) Clarify nature of 'path' parameter in oak-api
Date Wed, 15 Aug 2012 16:36:38 GMT

    [ https://issues.apache.org/jira/browse/OAK-221?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13435269#comment-13435269
] 

angela commented on OAK-221:
----------------------------

ok... i don't have any strong feelings regarding absolute or not.
but i do think it is important to have it consistent throughout the
code base, in particular as it grows quite fast. since Tree#getPath doesn't 
return an absolute path i thought this was the way to go and started to
use non-absolute path all over the place... let's make an effort to
clean that up next week during the oakathon.
                
> Clarify nature of 'path' parameter in oak-api
> ---------------------------------------------
>
>                 Key: OAK-221
>                 URL: https://issues.apache.org/jira/browse/OAK-221
>             Project: Jackrabbit Oak
>          Issue Type: Bug
>          Components: core
>            Reporter: angela
>
> imo the oak-api should be more specific about the nature of the
> path parameter that is passed to methods like Root#getTree, #move, #copy
> and that is returned by methods like Tree#getPath.
> The api documentation consistently states that those paths are "relative to
> the 'root' but when looking at the code i rather get the impression that
> they are absolute paths such as defined by the JCR API.
> for example:
> SessionDelegate#getNode(String path) just passes the path to the oak-api
> without making it 'relative to the root'. 
> on the other hand SessionDelegate#getRoot() passes an ""-path to Root#getTree.
> another example:
> SessionDelegate#getNodeByIdentifier starts like follows:
>   if (id.startsWith("/")) {
>      Tree tree = getTree(id);
>      [...]
> so, again the absolute jcr path is passed into the oak-api.
> requested action:
> - clarify oak-api
> - check all usages of oak-api and make api calls consistent

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message