public class Nav
extends java.lang.Object
Map
parameter "attributes" which can be used to parametrize the created result. It uses the names of Modifier and Type | Class and Description |
---|---|
class |
Nav.IndexCountingIterator<T>
An iterator implementation counting the index of returned results
|
static class |
Nav.RelationDataIterator
An iterator converting
WGRelationData into WGContent |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAVATT_ALLAREAS |
static java.lang.String |
NAVATT_ALLLANGUAGES |
static java.lang.String |
NAVATT_CONTENTCLASS |
static java.lang.String |
NAVATT_MAXLEVEL |
static java.lang.String |
NAVATT_ONLYPUBLISHED |
static java.lang.String |
NAVATT_ORDER |
static java.lang.String |
NAVATT_PAGESIZE |
static java.lang.String |
NAVATT_RELATION |
static java.lang.String |
NAVATT_RELATIONGROUP |
static java.lang.String |
NAVATT_ROLE |
static java.lang.String |
NAVTYPE_AREAS |
static java.lang.String |
NAVTYPE_CHILDREN |
static java.lang.String |
NAVTYPE_LANGUAGES |
static java.util.Map<java.lang.String,de.innovationgate.wga.server.api.Nav.NavTypeMetadata> |
NAVTYPE_METADATA |
static java.lang.String |
NAVTYPE_PARENTS |
static java.lang.String |
NAVTYPE_PATH |
static java.lang.String |
NAVTYPE_RELATIONGROUPTARGETS |
static java.lang.String |
NAVTYPE_SIBLINGS |
static java.lang.String |
NAVTYPE_SITEMAP |
static java.lang.String |
NAVTYPE_SOURCESOFINCOMINGRELATIONGROUPS |
static java.lang.String |
NAVTYPE_SOURCESOFINCOMINGRELATIONS |
static java.lang.String |
NAVTYPE_VERSIONS |
Modifier and Type | Method and Description |
---|---|
NavigatorResult |
areas()
Returns a NavigatorResult for an areas navigator, just like
|
NavigatorResult |
areas(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for an areas navigator, just like
|
NavigatorResult |
children()
Returns a NavigatorResult for a children navigator, just like
|
NavigatorResult |
children(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a children navigator, just like
|
NavigatorResult |
languages()
Returns a NavigatorResult for a languages navigator, just like
|
NavigatorResult |
languages(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a languages navigator, just like
|
NavigatorResult |
navigate(java.lang.String navType)
Returns a NavigatorResult for a WebTML navigator, just like
|
NavigatorResult |
navigate(java.lang.String navType,
java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a WebTML navigator, just like
|
NavigatorResult |
path()
Returns a NavigatorResult for a path navigator, just like
|
NavigatorResult |
path(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a path navigator, just like
|
NavigatorResult |
relationGroupTargets(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a navigator iterating over the targets of a relation group, just like
|
NavigatorResult |
relationGroupTargets(java.lang.String relationGroup)
Returns a NavigatorResult for a navigator iterating over the targets of a relation group, just like
|
NavigatorResult |
siblings()
Returns a NavigatorResult for a siblings navigator, just like
|
NavigatorResult |
siblings(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a siblings navigator, just like
|
NavigatorResult |
sitemap()
Returns a NavigatorResult for a sitemap navigator, just like
|
NavigatorResult |
sitemap(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a sitemap navigator, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups()
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups(java.lang.String relationGroup)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups(java.lang.String relationGroup,
java.lang.String contentClass)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelations()
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
sourcesOfIncomingRelations(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
sourcesOfIncomingRelations(java.lang.String relation)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
sourcesOfIncomingRelations(java.lang.String relation,
java.lang.String contentClass)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
versions()
Returns a NavigatorResult for a versions navigator, just like
|
NavigatorResult |
versions(java.util.Map<java.lang.String,java.lang.Object> atts)
Returns a NavigatorResult for a versions navigator, just like
|
public static final java.lang.String NAVTYPE_SOURCESOFINCOMINGRELATIONGROUPS
public static final java.lang.String NAVTYPE_SOURCESOFINCOMINGRELATIONS
public static final java.lang.String NAVTYPE_RELATIONGROUPTARGETS
public static final java.lang.String NAVTYPE_VERSIONS
public static final java.lang.String NAVTYPE_AREAS
public static final java.lang.String NAVTYPE_LANGUAGES
public static final java.lang.String NAVTYPE_SITEMAP
public static final java.lang.String NAVTYPE_PATH
public static final java.lang.String NAVTYPE_PARENTS
public static final java.lang.String NAVTYPE_SIBLINGS
public static final java.lang.String NAVTYPE_CHILDREN
public static final java.lang.String NAVATT_PAGESIZE
public static final java.lang.String NAVATT_ALLAREAS
public static final java.lang.String NAVATT_MAXLEVEL
public static final java.lang.String NAVATT_ALLLANGUAGES
public static final java.lang.String NAVATT_ROLE
public static final java.lang.String NAVATT_RELATIONGROUP
public static final java.lang.String NAVATT_RELATION
public static final java.lang.String NAVATT_CONTENTCLASS
public static final java.lang.String NAVATT_ONLYPUBLISHED
public static final java.lang.String NAVATT_ORDER
public static final java.util.Map<java.lang.String,de.innovationgate.wga.server.api.Nav.NavTypeMetadata> NAVTYPE_METADATA
public NavigatorResult children() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult children(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult siblings() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult siblings(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult path() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult path(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult sitemap() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult sitemap(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult languages() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult languages(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult areas() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult areas(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult versions() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult versions(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult relationGroupTargets(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult relationGroupTargets(java.lang.String relationGroup) throws de.innovationgate.webgate.api.WGException
relationGroup
- Name of the relation groupde.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelations() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelations(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelations(java.lang.String relation) throws de.innovationgate.webgate.api.WGException
relation
- Name of the relation which must point to the context document in order to be retrievedde.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelations(java.lang.String relation, java.lang.String contentClass) throws de.innovationgate.webgate.api.WGException
relation
- Name of the relation which must point to the context document in order to be retrievedcontentClass
- Content class that a source content must belong to in order to be retrievedde.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelationGroups() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelationGroups(java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelationGroups(java.lang.String relationGroup) throws de.innovationgate.webgate.api.WGException
relationGroup
- Name of the relation group which must point to the context document in order to be retrievedde.innovationgate.webgate.api.WGException
public NavigatorResult sourcesOfIncomingRelationGroups(java.lang.String relationGroup, java.lang.String contentClass) throws de.innovationgate.webgate.api.WGException
relationGroup
- Name of the relation group which must point to the context document in order to be retrievedcontentClass
- Content class that a source content must belong to in order to be retrievedde.innovationgate.webgate.api.WGException
public NavigatorResult navigate(java.lang.String navType) throws de.innovationgate.webgate.api.WGException
navType
- Type of the navigator, use constants NAVTYPE_...de.innovationgate.webgate.api.WGException
public NavigatorResult navigate(java.lang.String navType, java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
navType
- Type of the navigator, use constants NAVTYPE_...atts
- Attributes to influence the navigator result. Use attribute names of de.innovationgate.webgate.api.WGException