Skip navigation links

oracle.stellent.wcm.core.project.structure
Class SectionNode

java.lang.Object
oracle.stellent.wcm.core.project.structure.SectionNode

public class SectionNode

extends java.lang.Object

Represents the individual section of a WCM site

Field Summary

static java.lang.String	CONTRIBUTOR_ONLY
static java.lang.String	MAX_AGE
static java.lang.String	MAX_AGE_SECONDARY
static java.lang.String	NODEID
static java.lang.String	PRIMARY_PAGE
static java.lang.String	PRIMARY_PAGE_VIEWS
static java.lang.String	PRIMARY_PLACEHOLDER_CONFIG_URL
static java.lang.String	PRIMARY_VIEW_URL
static java.lang.String	SECONDARY_PAGE
static java.lang.String	SECONDARY_PAGE_VIEWS
static java.lang.String	SECONDARY_PLACEHOLDER_CONFIG_URL
static java.lang.String	SECONDARY_URL_VARIABLE_FIELD
static java.lang.String	SECONDARY_VIEW_URL
static java.lang.String	SECTION_ACTIVE
static java.lang.String	SECTION_CLBRA_ALIAS_LIST
static java.lang.String	SECTION_CLBRA_ROLE_LIST
static java.lang.String	SECTION_CLBRA_USER_LIST
static java.lang.String	SECTION_DOC_ACCOUNT
static java.lang.String	SECTION_LABEL
static java.lang.String	SECTION_SECURITY_GROUP
static java.lang.String	SECTION_URL_PAGENAME
static java.lang.String	SECTION_URLDIRNAME
static java.lang.String	SECTION_URLPATH

Constructor Summary

SectionNode(oracle.stellent.wcm.core.project.model.RootSectionType rootSectionType)

SectionNode(oracle.stellent.wcm.core.project.model.SectionType sectionType, SectionNode parentNode, int index)

SectionNode(oracle.stellent.wcm.core.project.model.SectionType sectionType, SectionNode parentNode, int index, boolean recurse)

Method Summary

protected void	addLayout(java.lang.String name, PageTemplate layout, boolean isRegEx)
protected PageTemplate	createLayoutFromUrl(java.lang.String url, java.lang.String viewUrl, java.lang.String replacableRegion, java.lang.String placeholderConfigMap, boolean isSecondary) Example: rvh_default?region1=rvh_servers&region2=rvh_logocontent <section active="TRUE" label="Home" nodeid="1" primaryUrl="TestLayout?region1=TestDataFile&region2=Test11gDataFile" primaryViewUrl="region1=FirstView&region2=SecondView" secondaryUrl="LegacySchemaLayout" secondaryViewUrl="regionA=UnpopularView&regionB=AwfulView" urlDirname="TestSiteOnCS10g">
java.util.List<SectionNode>	getActiveChildren()
java.util.List<SectionNode>	getAncestors()
java.util.List<SectionNode>	getChildren()
java.lang.String	getID()
int	getIndex()
PageTemplate	getLayout(java.lang.String name) Retrieve the path to a particular page mapped to this section
protected java.util.Map<java.lang.String,PageTemplate>	getLayoutMap()
java.util.Collection<java.lang.String>	getLayouts()
int	getLevel()
oracle.stellent.wcm.core.project.model.SectionType	getModel()
NamedPageNode	getNamedPageNodeByName(java.lang.String nodeName) Get a named node page in this section by name
java.util.List<NamedPageNode>	getNamedPageNodeList() Get the list of named page nodes in the section
SectionNode	getParent()
PageTemplate	getPrimaryLayout()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name) Retrieve a property from the section by name.
protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getPropertyEntrySet()
PageTemplate	getSecondaryLayout()
java.lang.String	getUrlPath()
boolean	hasNamedPages()
protected void	initLayoutMap()
protected void	initLayouts() Initialize the layouts
void	setPrimaryLayout(PageTemplate primaryLayout)
void	setProperty(java.lang.String name, java.lang.String value) Set the property via reflection; if no property is found, set in the section "otherAttributes" map
void	setSecondaryLayout(PageTemplate secondaryLayout)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTRIBUTOR_ONLY

public static final java.lang.String CONTRIBUTOR_ONLY

See Also:

Constant Field Values

SECTION_ACTIVE

public static final java.lang.String SECTION_ACTIVE

See Also:

Constant Field Values

NODEID

public static final java.lang.String NODEID

See Also:

Constant Field Values

SECTION_URLPATH

public static final java.lang.String SECTION_URLPATH

See Also:

Constant Field Values

SECTION_URLDIRNAME

public static final java.lang.String SECTION_URLDIRNAME

See Also:

Constant Field Values

SECTION_LABEL

public static final java.lang.String SECTION_LABEL

See Also:

Constant Field Values

SECTION_URL_PAGENAME

public static final java.lang.String SECTION_URL_PAGENAME

See Also:

Constant Field Values

PRIMARY_PAGE

public static final java.lang.String PRIMARY_PAGE

See Also:

Constant Field Values

SECONDARY_PAGE

public static final java.lang.String SECONDARY_PAGE

See Also:

Constant Field Values

PRIMARY_PAGE_VIEWS

public static final java.lang.String PRIMARY_PAGE_VIEWS

See Also:

Constant Field Values

PRIMARY_PLACEHOLDER_CONFIG_URL

public static final java.lang.String PRIMARY_PLACEHOLDER_CONFIG_URL

See Also:

Constant Field Values

SECONDARY_PAGE_VIEWS

public static final java.lang.String SECONDARY_PAGE_VIEWS

See Also:

Constant Field Values

SECONDARY_PLACEHOLDER_CONFIG_URL

public static final java.lang.String SECONDARY_PLACEHOLDER_CONFIG_URL

See Also:

Constant Field Values

SECONDARY_URL_VARIABLE_FIELD

public static final java.lang.String SECONDARY_URL_VARIABLE_FIELD

See Also:

Constant Field Values

MAX_AGE

public static final java.lang.String MAX_AGE

See Also:

Constant Field Values

MAX_AGE_SECONDARY

public static final java.lang.String MAX_AGE_SECONDARY

See Also:

Constant Field Values

SECTION_SECURITY_GROUP

public static final java.lang.String SECTION_SECURITY_GROUP

See Also:

Constant Field Values

SECTION_DOC_ACCOUNT

public static final java.lang.String SECTION_DOC_ACCOUNT

See Also:

Constant Field Values

SECTION_CLBRA_USER_LIST

public static final java.lang.String SECTION_CLBRA_USER_LIST

See Also:

Constant Field Values

SECTION_CLBRA_ALIAS_LIST

public static final java.lang.String SECTION_CLBRA_ALIAS_LIST

See Also:

Constant Field Values

SECTION_CLBRA_ROLE_LIST

public static final java.lang.String SECTION_CLBRA_ROLE_LIST

See Also:

Constant Field Values

PRIMARY_VIEW_URL

public static final java.lang.String PRIMARY_VIEW_URL

See Also:

Constant Field Values

SECONDARY_VIEW_URL

public static final java.lang.String SECONDARY_VIEW_URL

See Also:

Constant Field Values

Constructor Detail

SectionNode

public SectionNode(oracle.stellent.wcm.core.project.model.RootSectionType rootSectionType)

SectionNode

public SectionNode(oracle.stellent.wcm.core.project.model.SectionType sectionType,
                   SectionNode parentNode,
                   int index)

SectionNode

public SectionNode(oracle.stellent.wcm.core.project.model.SectionType sectionType,
                   SectionNode parentNode,
                   int index,
                   boolean recurse)

Method Detail

getPropertyEntrySet

protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getPropertyEntrySet()

Returns:

build a set of entries representing the name/value pairs of properties on this object

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns:

a map interface to the underlying properties. Note that any updates to the map will be reflected in this section object.

getProperty

public java.lang.String getProperty(java.lang.String name)
                             throws java.lang.Exception

Retrieve a property from the section by name. First queries the known properties, then looks in the "otherAttributes" Map

Parameters:

name - the property name

Returns:

the property

Throws:

java.lang.Exception - if an error occurs during reflection

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws java.lang.Exception

Set the property via reflection; if no property is found, set in the section "otherAttributes" map

Parameters:

name - the property name

value - the property value

Throws:

java.lang.Exception - if an error occurs during reflection

getModel

public oracle.stellent.wcm.core.project.model.SectionType getModel()

Returns:

the underlying jaxb model

getPrimaryLayout

public PageTemplate getPrimaryLayout()

Returns:

the layout for the primary page

setPrimaryLayout

public void setPrimaryLayout(PageTemplate primaryLayout)

getSecondaryLayout

public PageTemplate getSecondaryLayout()

Returns:

the layout for the secondary page

setSecondaryLayout

public void setSecondaryLayout(PageTemplate secondaryLayout)

getLevel

public int getLevel()

Returns:

the level in the tree where this node resides

getIndex

public int getIndex()

Returns:

the position in the current section list

getID

public java.lang.String getID()

Returns:

a unique section ID

getUrlPath

public java.lang.String getUrlPath()

Returns:

the hierarchical path to this segment, starting with a forward slash ("/")

getLayout

public PageTemplate getLayout(java.lang.String name)

Retrieve the path to a particular page mapped to this section

Parameters:

name - the page name

Returns:

the page for this section

getLayouts

public java.util.Collection<java.lang.String> getLayouts()

Returns:

the list of page names that are mapped to this section

getParent

public SectionNode getParent()

Returns:

the parent section or null if this is the root section

getAncestors

public java.util.List<SectionNode> getAncestors()

Returns:

the entire parent chain to the root

getChildren

public java.util.List<SectionNode> getChildren()

Returns:

the immediate child sections relative to the current section

getActiveChildren

public java.util.List<SectionNode> getActiveChildren()

Returns:

the immediate child sections relative to the current section that are active

getNamedPageNodeList

public java.util.List<NamedPageNode> getNamedPageNodeList()

Get the list of named page nodes in the section

Returns:

list of named page nodes

hasNamedPages

public boolean hasNamedPages()

getNamedPageNodeByName

public NamedPageNode getNamedPageNodeByName(java.lang.String nodeName)

Get a named node page in this section by name

Parameters:

nodeName - the name

Returns:

the namednodepage

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addLayout

protected void addLayout(java.lang.String name,
                         PageTemplate layout,
                         boolean isRegEx)

getLayoutMap

protected java.util.Map<java.lang.String,PageTemplate> getLayoutMap()

initLayouts

protected void initLayouts()

Initialize the layouts

initLayoutMap

protected void initLayoutMap()

createLayoutFromUrl

protected PageTemplate createLayoutFromUrl(java.lang.String url,
                                           java.lang.String viewUrl,
                                           java.lang.String replacableRegion,
                                           java.lang.String placeholderConfigMap,
                                           boolean isSecondary)

Example: rvh_default?region1=rvh_servers&region2=rvh_logocontent <section active="TRUE" label="Home" nodeid="1" primaryUrl="TestLayout?region1=TestDataFile&region2=Test11gDataFile" primaryViewUrl="region1=FirstView&region2=SecondView" secondaryUrl="LegacySchemaLayout" secondaryViewUrl="regionA=UnpopularView&regionB=AwfulView" urlDirname="TestSiteOnCS10g">

Parameters:

url - the url from the XML

viewUrl - the view mapping url

replacableRegion - the name of the replacable region (if specified)

placeholderConfigMap - a mapping of placeholder name to config

isSecondary - true if this is the secondary layout

Returns:

a template representing this URL

Skip navigation links