org.alfresco.repo.template
Class TemplateNode

java.lang.Object
  extended by org.alfresco.repo.template.BaseContentNode
      extended by org.alfresco.repo.template.BasePermissionsNode
          extended by org.alfresco.repo.template.TemplateNode
All Implemented Interfaces:
java.io.Serializable, TemplateContent, TemplateNodeRef, TemplatePermissions, TemplateProperties, org.alfresco.service.namespace.NamespacePrefixResolverProvider
Direct Known Subclasses:
CategoryTemplateNode

public class TemplateNode
extends BasePermissionsNode
implements org.alfresco.service.namespace.NamespacePrefixResolverProvider

Node class specific for use by Template pages that support Bean objects as part of the model. The default template engine FreeMarker can use these objects and they are provided to support it. A single method is completely freemarker specific - getXmlNodeModel()

The class exposes Node properties, children as dynamically populated maps and lists.

Various helper methods are provided to access common and useful node variables such as the content url and type information.

See http://wiki.alfresco.com/wiki/Template_Guide

See Also:
Serialized Form

Nested Class Summary
 class TemplateNode.TemplateAuditInfo
           
 
Nested classes/interfaces inherited from class org.alfresco.repo.template.BaseContentNode
BaseContentNode.TemplateContentData
 
Field Summary
protected  org.alfresco.service.cmr.repository.NodeRef nodeRef
          Cached values
 
Fields inherited from class org.alfresco.repo.template.BaseContentNode
aspects, children, CONTENT_DOWNLOAD_PROP_URL, CONTENT_DOWNLOAD_URL, CONTENT_GET_PROP_URL, CONTENT_GET_URL, CONTENT_SERVICE_GET_PROP_URL, CONTENT_SERVICE_GET_URL, FOLDER_BROWSE_URL, imageResolver, NAMESPACE_BEGIN, services
 
Constructor Summary
TemplateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef, ServiceRegistry services, TemplateImageResolver resolver)
          Constructor
 
Method Summary
 java.util.Map getAssociations()
           
 java.util.Map getAssocs()
           
 java.util.List getAuditTrail()
           
 java.util.Map getChildAssociations()
           
 java.util.Map getChildAssocs()
           
 java.util.List getChildAssocsByType(java.lang.String type)
           
 java.util.Map getChildByNamePath()
           
 java.util.Map getChildrenByLuceneSearch()
           
 java.util.Map getChildrenBySavedSearch()
           
 java.util.Map getChildrenByXPath()
           
 boolean getExists()
           
 java.lang.String getId()
           
 TemplateImageResolver getImageResolver()
           
 boolean getIsCategory()
           
 boolean getIsLocked()
           
 boolean getIsWorkingCopy()
           
 java.lang.String getName()
           
 org.alfresco.service.namespace.NamespacePrefixResolver getNamespacePrefixResolver()
           
 java.util.Map getNodeByReference()
           
 org.alfresco.service.cmr.repository.NodeRef getNodeRef()
           
 TemplateProperties getParent()
           
 org.alfresco.service.cmr.repository.ChildAssociationRef getPrimaryParentAssoc()
           
 java.util.Map getProperties()
           
 java.lang.String getShareUrl()
          This method returns a URL string which resolves to an Alfresco Share view of this node.
 java.util.Map getSourceAssociations()
           
 java.util.Map getSourceAssocs()
           
 java.lang.String getStoreId()
           
 java.lang.String getStoreType()
           
 org.alfresco.service.namespace.QName getType()
           
 java.lang.String getTypeShort()
           
 java.util.List getVersionHistory()
           
 freemarker.ext.dom.NodeModel getXmlNodeModel()
           
 
Methods inherited from class org.alfresco.repo.template.BasePermissionsNode
getDirectPermissions, getFullPermissions, getInheritsPermissions, getPermissions, hasPermission
 
Methods inherited from class org.alfresco.repo.template.BaseContentNode
getAspects, getChildren, getContent, getDisplayMimetype, getDisplayPath, getDownloadUrl, getEncoding, getHasChildren, getIcon16, getIcon32, getIcon64, getIsContainer, getIsDocument, getIsLinkToContainer, getIsLinkToDocument, getMimetype, getQnamePath, getServiceUrl, getSiteShortName, getSize, getUrl, getWebdavUrl, hasAspect, isTemplateContent, isTemplateNodeRef, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

nodeRef

protected org.alfresco.service.cmr.repository.NodeRef nodeRef
Cached values

Constructor Detail

TemplateNode

public TemplateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    ServiceRegistry services,
                    TemplateImageResolver resolver)
Constructor

Parameters:
nodeRef - The NodeRef this Node wrapper represents
services - The ServiceRegistry the TemplateNode can use to access services
resolver - Image resolver to use to retrieve icons
Method Detail

getId

public java.lang.String getId()
Specified by:
getId in interface TemplateNodeRef
Returns:
The GUID for the node

getStoreType

public java.lang.String getStoreType()
Returns:
the store type for the node

getStoreId

public java.lang.String getStoreId()
Returns:
the store id for the node

getNodeRef

public org.alfresco.service.cmr.repository.NodeRef getNodeRef()
Specified by:
getNodeRef in interface TemplateNodeRef
Returns:
Returns the NodeRef this Node object represents

getExists

public boolean getExists()
Returns:
true if this node still exists

getIsWorkingCopy

public boolean getIsWorkingCopy()
Returns:
true if this node is a working copy

getType

public org.alfresco.service.namespace.QName getType()
Specified by:
getType in interface TemplateNodeRef
Returns:
Returns the type.

getTypeShort

public java.lang.String getTypeShort()
Returns:
Returns the type in short format.

getName

public java.lang.String getName()
Specified by:
getName in interface TemplateNodeRef
Returns:
The display name for the node

getProperties

public java.util.Map getProperties()
Specified by:
getProperties in interface TemplateProperties
Returns:
All the properties known about this node.

getAssocs

public java.util.Map getAssocs()
Returns:
Target associations for this Node. As a Map of assoc name to a List of TemplateNodes.

getAssociations

public java.util.Map getAssociations()

getSourceAssocs

public java.util.Map getSourceAssocs()
Returns:
Source associations for this Node. As a Map of assoc name to a List of TemplateNodes.

getSourceAssociations

public java.util.Map getSourceAssociations()

getChildAssocs

public java.util.Map getChildAssocs()
Returns:
The child associations for this Node. As a Map of assoc name to a List of TemplateNodes.

getChildAssociations

public java.util.Map getChildAssociations()

getChildAssocsByType

public java.util.List getChildAssocsByType(java.lang.String type)
Returns:
The list of children of this Node that match a specific object type.

getIsLocked

public boolean getIsLocked()
Returns:
true if the node is currently locked

getIsCategory

public boolean getIsCategory()
Returns:
true if the node is a Category instance

getParent

public TemplateProperties getParent()
Specified by:
getParent in interface TemplateProperties
Returns:
the primary parent node

getPrimaryParentAssoc

public org.alfresco.service.cmr.repository.ChildAssociationRef getPrimaryParentAssoc()
Returns:
the primary parent association so we can access the association QName and association type QName.

getVersionHistory

public java.util.List getVersionHistory()
Returns:
a list of objects representing the version history of this node.
See Also:
VersionHistoryNode

getXmlNodeModel

public freemarker.ext.dom.NodeModel getXmlNodeModel()
Returns:
FreeMarker NodeModel for the XML content of this node, or null if no parsable XML found

getChildByNamePath

public java.util.Map getChildByNamePath()
Returns:
A map capable of returning the TemplateNode at the specified Path as a child of this node.

getChildrenByXPath

public java.util.Map getChildrenByXPath()
Returns:
A map capable of returning a List of TemplateNode objects from an XPath query as children of this node.

getChildrenBySavedSearch

public java.util.Map getChildrenBySavedSearch()
Returns:
A map capable of returning a List of TemplateNode objects from an NodeRef to a Saved Search object. The Saved Search is executed and the resulting nodes supplied as a sequence.

getChildrenByLuceneSearch

public java.util.Map getChildrenByLuceneSearch()
Returns:
A map capable of returning a List of TemplateNode objects from an NodeRef to a Lucene search string. The Saved Search is executed and the resulting nodes supplied as a sequence.

getNodeByReference

public java.util.Map getNodeByReference()
Returns:
A map capable of returning a TemplateNode for a single specified NodeRef reference.

getAuditTrail

public java.util.List getAuditTrail()
Returns:
a list of AuditInfo objects describing the Audit Trail for this node instance

getImageResolver

public TemplateImageResolver getImageResolver()
Returns:
the image resolver instance used by this node

getShareUrl

public java.lang.String getShareUrl()
This method returns a URL string which resolves to an Alfresco Share view of this node. Note that in order for this method to return meaningful data, the sysAdminParams bean must have been configured.

Currently this method only produces valid URls for documents and not for folders.

See Also:
SysAdminParamsImpl.setAlfrescoHost(String), SysAdminParamsImpl.setShareHost(String)

getNamespacePrefixResolver

public org.alfresco.service.namespace.NamespacePrefixResolver getNamespacePrefixResolver()
Specified by:
getNamespacePrefixResolver in interface org.alfresco.service.namespace.NamespacePrefixResolverProvider


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.