NavigationReader (Oracle WebCenter Sites Java API Reference)

```
public interface NavigationReader
```
A reader that reads a navigation hierarchy from PublicationTree given a starting node The node could be a Page asset, a SitePlan asset or a Publication. One can specify the level of children they would like the reader to return. The user also have the choice to specify whether it would like to retrieve all parents or not. For the returned nodes in hierarchy tree, one can leave it as default which the id and name of the node would be returned. Or if desired, one can specify an AssetReader to use to more specifically retrieve the attributes of the asset on the node use NavigationReader.useAssetReader(AssetReader) method Sample code snippet:
```
             AssetReader reader = new AssetReaderImpl(new AssetFacadeImpl(ics)).includeLinks(true);

              Map navMap = new NavigationReaderImpl( new AssetFacadeImpl(ics), new NavigationFacadeImpl(ics))
                .forNode( System.getProperty("assettype"), Long.parseLong(System.getProperty("assetid")) )
                .getSitePlanAssetNode(true)
                .levelOfChildren(1)
                .allParents(false)
                .useAssetReader(reader)
                .read();
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`children`
`static String`	`description`
`static String`	`name`
`static String`	`ncode`
`static String`	`nid`
`static String`	`nparentid`
`static String`	`nrank`
`static String`	`oid`
`static String`	`otype`
`static String`	`parent`
`static String`	`PARENTS`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NavigationReader`	`allParents(boolean allParent)` Whether all level of parents will be returned
`NavigationReader`	`forAsset(AssetId assetId)` The Page/SitePlan asset id for which the navigation is going to be build
`NavigationReader`	`forAssetName(String assetType, String assetName)` The Page/SitePlan asset name for which the navigation is going to be build
`NavigationReader`	`forAssetName(String assetType, String assetName, String siteName)` The Page/SitePlan asset name for which the navigation is going to be build
`NavigationReader`	`forNode(String type, Long id)` The Page/SitePlan/Publication type/id for which the navigation is going to be build
`NavigationReader`	`forSite(String siteName)` The site name for which the navigation is going to be build from
`NavigationReader`	`getPublicationNode(boolean getPublication)` specifies whether parents of typed Publication will be returned
`NavigationReader`	`getSiblings(boolean getSiblings)` Specifies whether siblings will be returned in reading of the tree
`NavigationReader`	`getSitePlanAssetNode(boolean getSitePlanAsset)` specifies whether parents typed SitePlan will be returned
`NavigationReader`	`levelOfChildren(int level)` Level of children will be retrieved, default to be 1
`Map`	`read()` Read the navigation hierarchy with information specified starting at the asset node specified.
`NavigationReader`	`useAssetReader(AssetReader assetReader)` The AssetReader to use to read the data
`NavigationReader`	`useAssetReader(String assettype, String subtype, AssetReader assetReader)` Specify an AssetReader to use page of specified assettype and subtype

- Field Detail
  - name
```
static final String name
```
    See Also:
    
    Constant Field Values
  - description
```
static final String description
```
    See Also:
    
    Constant Field Values
  - parent
```
static final String parent
```
    See Also:
    
    Constant Field Values
  - PARENTS
```
static final String PARENTS
```
    See Also:
    
    Constant Field Values
  - children
```
static final String children
```
    See Also:
    
    Constant Field Values
  - nrank
```
static final String nrank
```
    See Also:
    
    Constant Field Values
  - ncode
```
static final String ncode
```
    See Also:
    
    Constant Field Values
  - otype
```
static final String otype
```
    See Also:
    
    Constant Field Values
  - oid
```
static final String oid
```
    See Also:
    
    Constant Field Values
  - nparentid
```
static final String nparentid
```
    See Also:
    
    Constant Field Values
  - nid
```
static final String nid
```
    See Also:
    
    Constant Field Values
- Method Detail
  - forNode
```
NavigationReader forNode(String type,
                         Long id)
```
    The Page/SitePlan/Publication type/id for which the navigation is going to be build
    
    Parameters:
    
    type - type - Page, SitePlan, Publication
    
    id - long id
    
    Returns:
    
    a NavigationReader
  - forAsset
```
NavigationReader forAsset(AssetId assetId)
```
    The Page/SitePlan asset id for which the navigation is going to be build
    
    Parameters:
    
    assetId - build a navigation starting from an Asset typed of Page or SiteNavigation
    
    Returns:
    
    a NavigationReader
  - forAssetName
```
NavigationReader forAssetName(String assetType,
                              String assetName)
```
    The Page/SitePlan asset name for which the navigation is going to be build
    
    Parameters:
    
    assetType - the asset type, only Page/SitePlan is allowed here
    
    assetName - the Page/SitePlan name
    
    Returns:
    
    a NavigationReader
  - forAssetName
```
NavigationReader forAssetName(String assetType,
                              String assetName,
                              String siteName)
```
    The Page/SitePlan asset name for which the navigation is going to be build
    
    Parameters:
    
    assetType - the asset type, only Page/SitePlan is allowed here
    
    assetName - the Page/SitePlan name *
    
    siteName - the site from which the asset of the same will be searched from
    
    Returns:
    
    a NavigationReader
  - forSite
```
NavigationReader forSite(String siteName)
```
    The site name for which the navigation is going to be build from
    
    Parameters:
    
    siteName - site name
    
    Returns:
    
    a NavigationReader
  - useAssetReader
```
NavigationReader useAssetReader(AssetReader assetReader)
```
    The AssetReader to use to read the data
    
    Parameters:
    
    assetReader - the assetReader uses to read asset related data
    
    Returns:
    
    a NavigationReader
  - useAssetReader
```
NavigationReader useAssetReader(String assettype,
                                String subtype,
                                AssetReader assetReader)
```
    Specify an AssetReader to use page of specified assettype and subtype
    
    Parameters:
    
    assettype - the asset type
    
    subtype - the asset subtype
    
    assetReader - the assetReader
    
    Returns:
    
    an AssetReader
  - allParents
```
NavigationReader allParents(boolean allParent)
```
    Whether all level of parents will be returned
    
    Parameters:
    
    allParent - true indicate all parents will be returned, false only immediate parent will be returned
    
    Returns:
    
    a NavigationReader
  - levelOfChildren
```
NavigationReader levelOfChildren(int level)
```
    Level of children will be retrieved, default to be 1
    
    Parameters:
    
    level - the level of children
    
    Returns:
    
    a NavigationReader
  - getPublicationNode
```
NavigationReader getPublicationNode(boolean getPublication)
```
    specifies whether parents of typed Publication will be returned
    
    Parameters:
    
    getPublication - true indicate yes; false otherwise
    
    Returns:
    
    a NavigationReader
  - getSitePlanAssetNode
```
NavigationReader getSitePlanAssetNode(boolean getSitePlanAsset)
```
    specifies whether parents typed SitePlan will be returned
    
    Parameters:
    
    getSitePlanAsset - true indicates yes; false otherwise
    
    Returns:
    
    a NavigationReader
  - getSiblings
```
NavigationReader getSiblings(boolean getSiblings)
```
    Specifies whether siblings will be returned in reading of the tree
    
    Parameters:
    
    getSiblings - true indicates siblings will be returned in the Map, false otherwise
    
    Returns:
    
    a NavigationReader
  - read
```
Map read()
  throws AssetAccessException
```
    Read the navigation hierarchy with information specified starting at the asset node specified. The hierarchy map will contain a key named "parents", which will contain the information for the parents node, and a key named "children" that will contain the list of children nodes in the order specified, by default, if no order specified, it will be in the order of "ordinal". The map will also contain key for the current node information, which are "node", "nrank", "type", "id" and the information returned by the AssetReader specified in useAssetReader method
    
    Returns:
    
    a Map as a bean for the navigation hierarchy
    
    Throws:
    
    AssetAccessException - throws AssetAccessException

Interface NavigationReader

Field Summary

Method Summary

Field Detail

name

description

parent

PARENTS

children

nrank

ncode

otype

oid

nparentid

nid

Method Detail

forNode

forAsset

forAssetName

forAssetName

forSite

useAssetReader

useAssetReader

allParents

levelOfChildren

getPublicationNode

getSitePlanAssetNode

getSiblings

read