[
https://issues.apache.org/jira/browse/GEODE-1611?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15355605#comment-15355605
]
Darrel Schneider commented on GEODE-1611:
-----------------------------------------
Misinformation:
Each {@link com.gemstone.gemfire.cache.Cache} defines a single top region
called the root region.
User applications can use the root region to create subregions for isolated
name space and object grouping.
Correction:
The {@link com.gemstone.gemfire.cache.Cache} allows any number of root regions
to be created by calling "create" on a factory returned from one of the cache's
createRegionFactory methods.
* Subregions of an existing region (that is not partitioned) can be created
using the same region factory but calling "createSubregion".
Misinformation:
You can get the relative path from the root region with {@link #getFullPath}.
The name separator is used to concatenate all the region names together from
the root, starting with the root's subregions.
Correction:
You can get the absolute path with {@link #getFullPath}. The name separator is
used to concatenate all the region names together starting with the subregion's
root region.
Misinformation:
* Relative region names can provide a convenient
* method to locate a subregion directly from some higher region. For example,
* a region structure is as follows:
* a region named <i>3rd_level_region</i> has parent region
<i>2nd_level_region</i>; region
* <i>2nd_level_region</i> in turn has parent region <i>1st_level_region</i>;
and region
* <i>1st_level_region</i> is a child of the root region. Then,the user can
get the region
* <i>3rd_level_region</i> from the root region by issuing:
* <pre>
* <code>
* region3 =
root.getSubregion("1st_level_region/2nd_level_region/3rd_level_region");
* </code>
Correction:
* Region name paths provide a convenient
* method to locate a subregion directly from the cache or some higher region.
For example,
* a region structure is as follows:
* a region named <i>3rd_level_region</i> has parent region
<i>2nd_level_region</i>; region
* <i>2nd_level_region</i> in turn has parent region <i>1st_level_region</i>;
and region
* <i>1st_level_region</i> is a root region on the cache. Then, the user can
get the region
* <i>3rd_level_region</i> from the cache by issuing:
* <pre>
* <code>
* region3 =
cache.getRegion("1st_level_region/2nd_level_region/3rd_level_region");
* </code>
On the "getName" method:
Misinformation:
* If this is the root region, returns "root".
Correction:
just delete that sentence
On the "getParentRegion" method:
* @return the parent region which contains this region;
* null, if this region is the root region
Change: "the root" to: "a root"
> Region javadocs has misinformation regarding "the root region"
> --------------------------------------------------------------
>
> Key: GEODE-1611
> URL: https://issues.apache.org/jira/browse/GEODE-1611
> Project: Geode
> Issue Type: Bug
> Components: regions
> Reporter: Darrel Schneider
>
> The javadocs on the Region interface talks about "the root region". It no
> longer exists. Now users can create any number of root regions explicitly
> instead of the product having a single implicit root region.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
