BaseContentNode (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.repo.template.BaseContentNode

All Implemented Interfaces:

Serializable, TemplateContent, TemplateNodeRef, TemplateProperties

Direct Known Subclasses:

BasePermissionsNode, VersionHistoryNode
```
public abstract class BaseContentNode
extends Object
implements TemplateContent
```
Base class for Template API objects that supply content functionality.

Author:

Kevin Roast

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BaseContentNode.TemplateContentData
Inner class wrapping and providing access to a ContentData property

Nested Classes
Modifier and Type	Class and Description
`class`	`BaseContentNode.TemplateContentData` Inner class wrapping and providing access to a ContentData property

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<org.alfresco.service.namespace.QName>`	`aspects`
`protected List<TemplateProperties>`	`children` The children of this node
`protected static String`	`CONTENT_DOWNLOAD_PROP_URL`
`protected static String`	`CONTENT_DOWNLOAD_URL`
`protected static String`	`CONTENT_GET_PROP_URL`
`protected static String`	`CONTENT_GET_URL`
`protected static String`	`CONTENT_SERVICE_GET_PROP_URL`
`protected static String`	`CONTENT_SERVICE_GET_URL`
`protected static String`	`FOLDER_BROWSE_URL`
`protected TemplateImageResolver`	`imageResolver`
`protected static String`	`NAMESPACE_BEGIN`
`protected ServiceRegistry`	`services`

Constructor Summary

Constructors
Constructor and Description

BaseContentNode()

Constructors
Constructor and Description
`BaseContentNode()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<org.alfresco.service.namespace.QName>`	`getAspects()`
`List<TemplateProperties>`	`getChildren()`
`String`	`getContent()`
`String`	`getDisplayMimetype()`
`String`	`getDisplayPath()`
`String`	`getDownloadUrl()`
`String`	`getEncoding()`
`boolean`	`getHasChildren()`
`String`	`getIcon16()`
`String`	`getIcon32()`
`String`	`getIcon64()`
`boolean`	`getIsContainer()`
`boolean`	`getIsDocument()`
`boolean`	`getIsLinkToContainer()`
`boolean`	`getIsLinkToDocument()`
`String`	`getMimetype()`
`String`	`getQnamePath()`
`String`	`getServiceUrl()`
`String`	`getSiteShortName()` Returns the short name of the site this node is located within.
`long`	`getSize()`
`String`	`getUrl()`
`String`	`getWebdavUrl()`
`boolean`	`hasAspect(String aspect)`
`boolean`	`isTemplateContent(Object o)` Helper to return true if the supplied property value is a TemplateContentData object
`boolean`	`isTemplateNodeRef(Object o)` Helper to return true if the supplied property value is a TemplateNodeRef object
`String`	`toString()` Override Object.toString() to provide useful debug output

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.repo.template.TemplateProperties
getParent, getProperties

Methods inherited from interface org.alfresco.repo.template.TemplateNodeRef
getId, getName, getNodeRef, getType

- Field Detail
  - CONTENT_GET_URL
```
protected static final String CONTENT_GET_URL
```
    See Also:
    
    Constant Field Values
  - CONTENT_GET_PROP_URL
```
protected static final String CONTENT_GET_PROP_URL
```
    See Also:
    
    Constant Field Values
  - CONTENT_DOWNLOAD_URL
```
protected static final String CONTENT_DOWNLOAD_URL
```
    See Also:
    
    Constant Field Values
  - CONTENT_DOWNLOAD_PROP_URL
```
protected static final String CONTENT_DOWNLOAD_PROP_URL
```
    See Also:
    
    Constant Field Values
  - CONTENT_SERVICE_GET_URL
```
protected static final String CONTENT_SERVICE_GET_URL
```
    See Also:
    
    Constant Field Values
  - CONTENT_SERVICE_GET_PROP_URL
```
protected static final String CONTENT_SERVICE_GET_PROP_URL
```
    See Also:
    
    Constant Field Values
  - FOLDER_BROWSE_URL
```
protected static final String FOLDER_BROWSE_URL
```
    See Also:
    
    Constant Field Values
  - NAMESPACE_BEGIN
```
protected static final String NAMESPACE_BEGIN
```
    See Also:
    
    Constant Field Values
  - children
```
protected List<TemplateProperties> children
```
    The children of this node
  - services
```
protected ServiceRegistry services
```
  - imageResolver
```
protected TemplateImageResolver imageResolver
```
  - aspects
```
protected Set<org.alfresco.service.namespace.QName> aspects
```
- Constructor Detail
  - BaseContentNode
```
public BaseContentNode()
```
- Method Detail
  - getIsContainer
```
public boolean getIsContainer()
```
    Returns:
    
    true if this Node is a container (i.e. a folder)
  - getIsDocument
```
public boolean getIsDocument()
```
    Returns:
    
    true if this Node is a Document (i.e. with content)
  - getIsLinkToContainer
```
public boolean getIsLinkToContainer()
```
    Returns:
    
    true if this Node is a Link to a Container (i.e. a folderlink)
  - getIsLinkToDocument
```
public boolean getIsLinkToDocument()
```
    Returns:
    
    true if this Node is a Link to a Document (i.e. a filelink)
  - toString
```
public String toString()
```
    Override Object.toString() to provide useful debug output
    
    Overrides:
    
    toString in class Object
  - getQnamePath
```
public String getQnamePath()
```
    Returns:
    
    QName path to this node. This can be used for Lucene PATH: style queries
  - getIcon16
```
public String getIcon16()
```
    Returns:
    
    the small icon image for this node
  - getIcon32
```
public String getIcon32()
```
    Returns:
    
    the medium icon image for this node
  - getIcon64
```
public String getIcon64()
```
    Returns:
    
    the large icon image for this node
  - getDisplayPath
```
public String getDisplayPath()
```
    Returns:
    
    Display path to this node - the path built of 'cm:name' attribute values.
  - getChildren
```
public List<TemplateProperties> getChildren()
```
    Specified by:
    
    getChildren in interface TemplateProperties
    
    Returns:
    
    The children of this Node as objects that support the TemplateProperties contract.
  - getHasChildren
```
public boolean getHasChildren()
```
    Returns:
    
    true if the node has the children false otherwise
  - getAspects
```
public Set<org.alfresco.service.namespace.QName> getAspects()
```
    Specified by:
    
    getAspects in interface TemplateProperties
    
    Returns:
    
    The list of aspects applied to this node
  - hasAspect
```
public boolean hasAspect(String aspect)
```
    Specified by:
    
    hasAspect in interface TemplateProperties
    
    Parameters:
    
    aspect - The aspect name to test for
    
    Returns:
    
    true if the node has the aspect false otherwise
  - getContent
```
public String getContent()
```
    Specified by:
    
    getContent in interface TemplateContent
    
    Returns:
    
    the content String for this node from the default content property (@see ContentModel.PROP_CONTENT)
  - getUrl
```
public String getUrl()
```
    Specified by:
    
    getUrl in interface TemplateContent
    
    Returns:
    
    For a content document, this method returns the URL to the content stream for the default content property (@see ContentModel.PROP_CONTENT)
    For a container node, this method return the URL to browse to the folder in the web-client
  - getDownloadUrl
```
public String getDownloadUrl()
```
    Specified by:
    
    getDownloadUrl in interface TemplateContent
    
    Returns:
    
    For a content document, this method returns the download URL to the content for the default content property (@see ContentModel.PROP_CONTENT)
    For a container node, this method returns an empty string
  - getServiceUrl
```
public String getServiceUrl()
```
  - getWebdavUrl
```
public String getWebdavUrl()
```
    Returns:
    
    The WebDav cm:name based path to the content for the default content property (@see ContentModel.PROP_CONTENT)
  - getMimetype
```
public String getMimetype()
```
    Specified by:
    
    getMimetype in interface TemplateContent
    
    Returns:
    
    The mimetype encoding for content attached to the node from the default content property (@see ContentModel.PROP_CONTENT)
  - getDisplayMimetype
```
public String getDisplayMimetype()
```
    Returns:
    
    The display label of the mimetype encoding for content attached to the node from the default content property (@see ContentModel.PROP_CONTENT)
  - getEncoding
```
public String getEncoding()
```
    Returns:
    
    The character encoding for content attached to the node from the default content property (@see ContentModel.PROP_CONTENT)
  - getSize
```
public long getSize()
```
    Specified by:
    
    getSize in interface TemplateContent
    
    Returns:
    
    The size in bytes of the content attached to the node from the default content property (@see ContentModel.PROP_CONTENT)
  - isTemplateContent
```
public boolean isTemplateContent(Object o)
```
    Helper to return true if the supplied property value is a TemplateContentData object
    
    Parameters:
    
    o - Object to test
    
    Returns:
    
    true if instanceof TemplateContentData, false otherwise
  - isTemplateNodeRef
```
public boolean isTemplateNodeRef(Object o)
```
    Helper to return true if the supplied property value is a TemplateNodeRef object
    
    Parameters:
    
    o - Object to test
    
    Returns:
    
    true if instanceof isTemplateNodeRef, false otherwise
  - getSiteShortName
```
public String getSiteShortName()
```
    Returns the short name of the site this node is located within. If the node is not located within a site null is returned.
    
    Returns:
    
    The short name of the site this node is located within, null if the node is not located within a site.

Class BaseContentNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.alfresco.repo.template.TemplateProperties

Methods inherited from interface org.alfresco.repo.template.TemplateNodeRef

Field Detail

CONTENT_GET_URL

CONTENT_GET_PROP_URL

CONTENT_DOWNLOAD_URL

CONTENT_DOWNLOAD_PROP_URL

CONTENT_SERVICE_GET_URL

CONTENT_SERVICE_GET_PROP_URL

FOLDER_BROWSE_URL

NAMESPACE_BEGIN

children

services

imageResolver

aspects

Constructor Detail

BaseContentNode

Method Detail

getIsContainer

getIsDocument

getIsLinkToContainer

getIsLinkToDocument

toString

getQnamePath

getIcon16

getIcon32

getIcon64

getDisplayPath

getChildren

getHasChildren

getAspects

hasAspect

getContent

getUrl

getDownloadUrl

getServiceUrl

getWebdavUrl

getMimetype

getDisplayMimetype

getEncoding

getSize

isTemplateContent

isTemplateNodeRef

getSiteShortName