public class Nav extends 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 String |
NAVATT_ALLAREAS |
static String |
NAVATT_ALLLANGUAGES |
static String |
NAVATT_CONTENTCLASS |
static String |
NAVATT_MAXLEVEL |
static String |
NAVATT_ONLYPUBLISHED |
static String |
NAVATT_ORDER |
static String |
NAVATT_PAGESIZE |
static String |
NAVATT_RELATION |
static String |
NAVATT_RELATIONGROUP |
static String |
NAVATT_ROLE |
static String |
NAVTYPE_AREAS |
static String |
NAVTYPE_CHILDREN |
static String |
NAVTYPE_LANGUAGES |
static Map<String,de.innovationgate.wga.server.api.Nav.NavTypeMetadata> |
NAVTYPE_METADATA |
static String |
NAVTYPE_PARENTS |
static String |
NAVTYPE_PATH |
static String |
NAVTYPE_RELATIONGROUPTARGETS |
static String |
NAVTYPE_SIBLINGS |
static String |
NAVTYPE_SITEMAP |
static String |
NAVTYPE_SOURCESOFINCOMINGRELATIONGROUPS |
static String |
NAVTYPE_SOURCESOFINCOMINGRELATIONS |
static String |
NAVTYPE_VERSIONS |
Modifier and Type | Method and Description |
---|---|
NavigatorResult |
areas()
Returns a NavigatorResult for an areas navigator, just like
|
NavigatorResult |
areas(Map<String,Object> atts)
Returns a NavigatorResult for an areas navigator, just like
|
NavigatorResult |
children()
Returns a NavigatorResult for a children navigator, just like
|
NavigatorResult |
children(Map<String,Object> atts)
Returns a NavigatorResult for a children navigator, just like
|
NavigatorResult |
languages()
Returns a NavigatorResult for a languages navigator, just like
|
NavigatorResult |
languages(Map<String,Object> atts)
Returns a NavigatorResult for a languages navigator, just like
|
NavigatorResult |
navigate(String navType)
Returns a NavigatorResult for a WebTML navigator, just like
|
NavigatorResult |
navigate(String navType,
Map<String,Object> atts)
Returns a NavigatorResult for a WebTML navigator, just like
|
NavigatorResult |
path()
Returns a NavigatorResult for a path navigator, just like
|
NavigatorResult |
path(Map<String,Object> atts)
Returns a NavigatorResult for a path navigator, just like
|
NavigatorResult |
relationGroupTargets(Map<String,Object> atts)
Returns a NavigatorResult for a navigator iterating over the targets of a relation group, just like
|
NavigatorResult |
relationGroupTargets(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(Map<String,Object> atts)
Returns a NavigatorResult for a siblings navigator, just like
|
NavigatorResult |
sitemap()
Returns a NavigatorResult for a sitemap navigator, just like
|
NavigatorResult |
sitemap(Map<String,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(Map<String,Object> atts)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups(String relationGroup)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relation groups, just like
|
NavigatorResult |
sourcesOfIncomingRelationGroups(String relationGroup,
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(Map<String,Object> atts)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
sourcesOfIncomingRelations(String relation)
Returns a NavigatorResult for a navigator iterating over the sources of incoming relations, just like
|
NavigatorResult |
sourcesOfIncomingRelations(String relation,
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(Map<String,Object> atts)
Returns a NavigatorResult for a versions navigator, just like
|
public static final String NAVTYPE_SOURCESOFINCOMINGRELATIONGROUPS
public static final String NAVTYPE_SOURCESOFINCOMINGRELATIONS
public static final String NAVTYPE_RELATIONGROUPTARGETS
public static final String NAVTYPE_VERSIONS
public static final String NAVTYPE_AREAS
public static final String NAVTYPE_LANGUAGES
public static final String NAVTYPE_SITEMAP
public static final String NAVTYPE_PATH
public static final String NAVTYPE_PARENTS
public static final String NAVTYPE_SIBLINGS
public static final String NAVTYPE_CHILDREN
public static final String NAVATT_PAGESIZE
public static final String NAVATT_ALLAREAS
public static final String NAVATT_MAXLEVEL
public static final String NAVATT_ALLLANGUAGES
public static final String NAVATT_ROLE
public static final String NAVATT_RELATIONGROUP
public static final String NAVATT_RELATION
public static final String NAVATT_CONTENTCLASS
public static final String NAVATT_ONLYPUBLISHED
public static final String NAVATT_ORDER
public NavigatorResult children() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public NavigatorResult children(Map<String,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(Map<String,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(Map<String,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(Map<String,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(Map<String,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(Map<String,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(Map<String,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(Map<String,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(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(Map<String,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(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(String relation, 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(Map<String,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(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(String relationGroup, 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(String navType) throws de.innovationgate.webgate.api.WGException
navType
- Type of the navigator, use constants NAVTYPE_...de.innovationgate.webgate.api.WGException
public NavigatorResult navigate(String navType, Map<String,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