org.hippoecm.hst.core.linking
Interface LocationResolver

All Known Subinterfaces:
ResourceLocationResolver
All Known Implementing Classes:
HippoResourceLocationResolver

public interface LocationResolver


Method Summary
 String getNodeType()
           
 HstLink resolve(javax.jcr.Node node, Mount mount)
          Implementations should here do their logic, possibly linkrewriting.
 void setLocationMapTree(LocationMapTree locationMapTree)
          this setter will always be called when a LocationResolver implementation class is created.
 

Method Detail

resolve

HstLink resolve(javax.jcr.Node node,
                Mount mount)
Implementations should here do their logic, possibly linkrewriting. With the resolved path from this method, a HstLink object is created

Parameters:
node -
mount - the Mount where the HstLink should be created for
Returns:
the resolved HstLink for the node, or null when not able to create one

setLocationMapTree

void setLocationMapTree(LocationMapTree locationMapTree)
this setter will always be called when a LocationResolver implementation class is created. The locationMapTree can be used for linkrewriting: it is some sort of inversed HstSiteMapItem's object: the relativecontentpath items of the HstSiteMap tree are the 'tree' in the locationMapTree. Of course, your LocationResolver might not need the locationMapTree at all. Then, just keep this method empty

Parameters:
locationMapTree -

getNodeType

String getNodeType()
Returns:
the node type this resolver works on


Copyright © 2008-2012 Hippo. All Rights Reserved.