mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-16 17:55:15 +00:00
98f2e85cc0
Provides access to AVM stores and nodes within those stores. The majority of the standard template Node API is available (such as properties, children, content, icons etc.) and some additional AVM specific methods. Root level helper object 'avm' provides lookup for AVM store object and AVM nodes objects by path in the OO style expected by template writers. Once retrieved, the store object provides store meta-data and access to the root Template AVM node for the store (or lookup of individual nodes by path) which exposes the standard template Node API. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5460 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
292 lines
8.8 KiB
Java
292 lines
8.8 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.template;
|
|
|
|
import java.io.Serializable;
|
|
import java.io.UnsupportedEncodingException;
|
|
import java.net.URLEncoder;
|
|
import java.text.MessageFormat;
|
|
import java.util.Date;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.service.ServiceRegistry;
|
|
import org.alfresco.service.cmr.repository.ContentData;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.TemplateException;
|
|
import org.alfresco.service.cmr.version.Version;
|
|
import org.alfresco.service.cmr.version.VersionType;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.alfresco.service.namespace.QNameMap;
|
|
import org.springframework.util.StringUtils;
|
|
|
|
/**
|
|
* Template Node wrapper representing a record in the version history of a node.
|
|
* Provides access to basic properties and version information for the frozen state record.
|
|
*
|
|
* @author Kevin Roast
|
|
*/
|
|
public class VersionHistoryNode extends BaseContentNode
|
|
{
|
|
private QNameMap<String, Serializable> properties;
|
|
private boolean propsRetrieved = false;
|
|
private Version version;
|
|
private TemplateNode parent;
|
|
private Set<QName> aspects = null;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param version Descriptor of the node version information
|
|
*/
|
|
public VersionHistoryNode(Version version, TemplateNode parent, ServiceRegistry services)
|
|
{
|
|
if (version == null)
|
|
{
|
|
throw new IllegalArgumentException("Version history descriptor is mandatory.");
|
|
}
|
|
if (parent == null)
|
|
{
|
|
throw new IllegalArgumentException("Parent TemplateNode is mandatory.");
|
|
}
|
|
if (services == null)
|
|
{
|
|
throw new IllegalArgumentException("The ServiceRegistry must be supplied.");
|
|
}
|
|
this.version = version;
|
|
this.parent = parent;
|
|
this.services = services;
|
|
this.properties = new QNameMap<String, Serializable>(parent.services.getNamespaceService());
|
|
}
|
|
|
|
/**
|
|
* @return The GUID for the frozen state NodeRef
|
|
*/
|
|
public String getId()
|
|
{
|
|
return this.version.getFrozenStateNodeRef().getId();
|
|
}
|
|
|
|
/**
|
|
* @return Returns the frozen state NodeRef this record represents
|
|
*/
|
|
public NodeRef getNodeRef()
|
|
{
|
|
return this.version.getFrozenStateNodeRef();
|
|
}
|
|
|
|
/**
|
|
* @return Returns the type.
|
|
*/
|
|
public QName getType()
|
|
{
|
|
return parent.services.getNodeService().getType(this.version.getFrozenStateNodeRef());
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the item name.
|
|
*
|
|
* @return the item name
|
|
*/
|
|
public String getName()
|
|
{
|
|
return (String)this.getProperties().get(ContentModel.PROP_NAME);
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the created date from the version property data.
|
|
*
|
|
* @return the date the version was created
|
|
*/
|
|
public Date getCreatedDate()
|
|
{
|
|
return this.version.getCreatedDate();
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the creator of the version.
|
|
*
|
|
* @return the creator of the version
|
|
*/
|
|
public String getCreator()
|
|
{
|
|
return this.version.getCreator();
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the version label from the version property data.
|
|
*
|
|
* @return the version label
|
|
*/
|
|
public String getVersionLabel()
|
|
{
|
|
return this.version.getVersionLabel();
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the version type.
|
|
*
|
|
* @return true if this is a major version, false otherwise.
|
|
*/
|
|
public boolean getIsMajorVersion()
|
|
{
|
|
return (this.version.getVersionType() == VersionType.MAJOR);
|
|
}
|
|
|
|
/**
|
|
* Helper method to get the version description.
|
|
*
|
|
* @return the version description
|
|
*/
|
|
public String getDescription()
|
|
{
|
|
return this.version.getDescription();
|
|
}
|
|
|
|
/**
|
|
* Get the map containing the version property values.
|
|
*
|
|
* @return the map containing the version properties
|
|
*/
|
|
public Map<String, Serializable> getProperties()
|
|
{
|
|
if (propsRetrieved == false)
|
|
{
|
|
Map<QName, Serializable> props = parent.services.getNodeService().getProperties(
|
|
this.version.getFrozenStateNodeRef());
|
|
|
|
for (QName qname : props.keySet())
|
|
{
|
|
Serializable propValue = props.get(qname);
|
|
if (propValue instanceof NodeRef)
|
|
{
|
|
// NodeRef object properties are converted to new TemplateNode objects
|
|
// so they can be used as objects within a template
|
|
propValue = new TemplateNode(((NodeRef)propValue), parent.services, parent.imageResolver);
|
|
}
|
|
else if (propValue instanceof ContentData)
|
|
{
|
|
// ContentData object properties are converted to TemplateContentData objects
|
|
// so the content and other properties of those objects can be accessed
|
|
propValue = parent.new TemplateContentData((ContentData)propValue, qname);
|
|
}
|
|
this.properties.put(qname.toString(), propValue);
|
|
}
|
|
|
|
propsRetrieved = true;
|
|
}
|
|
|
|
return this.properties;
|
|
}
|
|
|
|
/**
|
|
* @return The list of aspects applied to this node
|
|
*/
|
|
public Set<QName> getAspects()
|
|
{
|
|
if (this.aspects == null)
|
|
{
|
|
this.aspects = parent.services.getNodeService().getAspects(this.version.getFrozenStateNodeRef());
|
|
}
|
|
|
|
return this.aspects;
|
|
}
|
|
|
|
/**
|
|
* @param aspect The aspect name to test for
|
|
*
|
|
* @return true if the node has the aspect false otherwise
|
|
*/
|
|
public boolean hasAspect(String aspect)
|
|
{
|
|
if (this.aspects == null)
|
|
{
|
|
getAspects();
|
|
}
|
|
|
|
if (aspect.startsWith(parent.NAMESPACE_BEGIN))
|
|
{
|
|
return aspects.contains((QName.createQName(aspect)));
|
|
}
|
|
else
|
|
{
|
|
boolean found = false;
|
|
for (QName qname : this.aspects)
|
|
{
|
|
if (qname.toPrefixString(parent.services.getNamespaceService()).equals(aspect))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
return found;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.repo.template.TemplateProperties#getChildren()
|
|
*/
|
|
public List<TemplateProperties> getChildren()
|
|
{
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.repo.template.TemplateProperties#getParent()
|
|
*/
|
|
public TemplateProperties getParent()
|
|
{
|
|
return null;
|
|
}
|
|
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Content API
|
|
|
|
/**
|
|
* @return Returns the URL to the content stream for the frozen state of the node from
|
|
* the default content property (@see ContentModel.PROP_CONTENT)
|
|
*/
|
|
@Override
|
|
public String getUrl()
|
|
{
|
|
NodeRef nodeRef = this.version.getFrozenStateNodeRef();
|
|
try
|
|
{
|
|
return MessageFormat.format(parent.CONTENT_DEFAULT_URL, new Object[] {
|
|
nodeRef.getStoreRef().getProtocol(),
|
|
nodeRef.getStoreRef().getIdentifier(),
|
|
nodeRef.getId(),
|
|
StringUtils.replace(URLEncoder.encode(getName(), "UTF-8"), "+", "%20") } );
|
|
}
|
|
catch (UnsupportedEncodingException err)
|
|
{
|
|
throw new TemplateException("Failed to encode content URL for node: " + nodeRef, err);
|
|
}
|
|
}
|
|
}
|