Package com.hannonhill.cascade.velocity

Class LocatorTool

java.lang.Object

com.hannonhill.cascade.velocity.LocatorTool

public class LocatorTool
extends java.lang.Object

Tool that allows locating assets in Cascade from the Velocity format

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LocatorTool.SearchQuery	A search query object that can be used to query for assets using the LocatorTool.

Constructor Summary

Constructors

Constructor	Description
LocatorTool(java.lang.String siteId, com.hannonhill.cascade.model.service.ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
FolderContainedAsset	locate(java.lang.String path, com.hannonhill.cascade.model.dom.identifier.EntityType type)
FolderContainedAsset	locate(java.lang.String path, com.hannonhill.cascade.model.dom.identifier.EntityType type, java.lang.String siteName)
Block	locateBlock(java.lang.String path)
Block	locateBlock(java.lang.String path, java.lang.String siteName)
File	locateFile(java.lang.String path)
File	locateFile(java.lang.String path, java.lang.String siteName)
Folder	locateFolder(java.lang.String path)
Folder	locateFolder(java.lang.String path, java.lang.String siteName)
Format	locateFormat(java.lang.String path)
Format	locateFormat(java.lang.String path, java.lang.String siteName)
FolderContainedAsset	locateLinkable(java.lang.String path)
FolderContainedAsset	locateLinkable(java.lang.String path, java.lang.String siteName)
Page	locatePage(java.lang.String path)
Page	locatePage(java.lang.String path, java.lang.String siteName)
Reference	locateReference(java.lang.String path)
Reference	locateReference(java.lang.String path, java.lang.String siteName)
Symlink	locateSymlink(java.lang.String path)
Symlink	locateSymlink(java.lang.String path, java.lang.String siteName)
LocatorTool.SearchQuery	query()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocatorTool

public LocatorTool(java.lang.String siteId,
                   com.hannonhill.cascade.model.service.ServiceProvider serviceProvider)

Parameters:

siteId - Velocity format's site id

Method Detail

locatePage

public Page locatePage(java.lang.String path)

locatePage

public Page locatePage(java.lang.String path,
                       java.lang.String siteName)

query

public LocatorTool.SearchQuery query()

locateFolder

public Folder locateFolder(java.lang.String path)

locateFolder

public Folder locateFolder(java.lang.String path,
                           java.lang.String siteName)

locateBlock

public Block locateBlock(java.lang.String path)

locateBlock

public Block locateBlock(java.lang.String path,
                         java.lang.String siteName)

locateFormat

public Format locateFormat(java.lang.String path,
                           java.lang.String siteName)

locateFormat

public Format locateFormat(java.lang.String path)

locateFile

public File locateFile(java.lang.String path)

locateFile

public File locateFile(java.lang.String path,
                       java.lang.String siteName)

locateSymlink

public Symlink locateSymlink(java.lang.String path)

locateSymlink

public Symlink locateSymlink(java.lang.String path,
                             java.lang.String siteName)

locateLinkable

public FolderContainedAsset locateLinkable(java.lang.String path,
                                           java.lang.String siteName)

locateLinkable

public FolderContainedAsset locateLinkable(java.lang.String path)

locateReference

public Reference locateReference(java.lang.String path)

locateReference

public Reference locateReference(java.lang.String path,
                                 java.lang.String siteName)

locate

public FolderContainedAsset locate(java.lang.String path,
                                   com.hannonhill.cascade.model.dom.identifier.EntityType type)

locate

public FolderContainedAsset locate(java.lang.String path,
                                   com.hannonhill.cascade.model.dom.identifier.EntityType type,
                                   java.lang.String siteName)