org.outerj.daisy.navigation
Class NavigationLookupResult
java.lang.Object
org.outerj.daisy.navigation.NavigationLookupResult
public class NavigationLookupResult
- extends java.lang.Object
Encapsulates information about the result of a navigation tree lookup.
Either the lookup matched a document node in which case the variantKey
field will identify that document, and the navigationPath
field will contain the corresponding path in the navigation tree (the
same as the one provided when doing the lookup).
If the lookup matched
a group node or the lookup didn't match but the path ended on a document
ID and the document is found at another location in the tree of one
of the lookup variants, the redirect field will be true, the navigationPath
field will contain the path to where to redirect, and the lookupAlternativeName
will contain the name of the lookupAlternative which matched.
If the lookup didn't match and the path ended on a document ID but
the document ID does not occur in the tree, then the redirect field will
be false, the navigationPath will contain an empty string and the variantKey
field will contain a variant key with that document ID and the branch
and language of the navigation tree document.
In all other cases, the notFound field will be true.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
createMatchResult
public static NavigationLookupResult createMatchResult(org.outerj.daisy.repository.VariantKey variantKey,
java.lang.String navigationPath)
createRedirectResult
public static NavigationLookupResult createRedirectResult(java.lang.String lookupAlternativeName,
java.lang.String navigationPath,
org.outerj.daisy.repository.VariantKey variantKey)
createNotFoundResult
public static NavigationLookupResult createNotFoundResult()
createFromXml
public static NavigationLookupResult createFromXml(org.outerx.daisy.x10Navigationspec.NavigationLookupResultDocument.NavigationLookupResult resultXml)
getVariantKey
public org.outerj.daisy.repository.VariantKey getVariantKey()
getNavigationPath
public java.lang.String getNavigationPath()
isRedirect
public boolean isRedirect()
isNotFound
public boolean isNotFound()
getLookupAlternativeName
public java.lang.String getLookupAlternativeName()
getXml
public org.outerx.daisy.x10Navigationspec.NavigationLookupResultDocument getXml()
Copyright © -2012 . All Rights Reserved.