senselogic.sitevision.api.metadata

Interface MetadataDefinitionUtil

@Requireable(value="MetadataDefinitionUtil")
public interface MetadataDefinitionUtil

Utility interface for getting metadata definitions.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getMetadataDefinitionUtil(). See Utils for how to obtain an instance of the Utils interface.

Velocity example: This code gets all properties and nodes for a metadata definition named 'aMetadataName'.

   #set ($page = ...)

   #set ($definitionUtil = $sitevisionUtils.metadataDefinitionUtil)
   #set($definition = $definitionUtil.getDefinition($page, 'aMetadataName'))

   #set($nodes = $definition.getNodes())
   #foreach($node in $nodes)
      $node
   #end

   #set($properties = $definition.getProperties())
   #foreach($property in $properties)
      $property
   #end
 

Since:

Sitevision 2.6.2_04

Author:

Daniel Pyykkö

Method Summary

Modifier and Type	Method and Description
void	addAlternative(Node aNode, String aDefinitionName, String aAlternativeName) Add an alternative to a definition
Node	getDefinition(Node aNode, String aDefinitionName) Gets a metadata definition as a Node from a Node.
Node	getDefinition(Node aNode, String aDefinitionName, Node aDefaultValue) Gets a metadata definition as a Node from a Node with a fallback value if the definition does not exist.
List<Node>	getDefinitions(Node aNode) Gets all metadata definitions available for the current user on a Node
void	removeAlternative(Node aNode, String aDefinitionName, String aAlternativeName) Remove an alternative from a definition
void	renameAlternative(Node aNode, String aDefinitionName, String aAlternativeName, String aNewAlternativeName) Rename an alternative for a definition

Method Detail

getDefinition

Node getDefinition(Node aNode,
                   String aDefinitionName)

Gets a metadata definition as a Node from a Node.

Parameters:

aNode - the Node that has a metadata definition

aDefinitionName - the name of the metadata definition

Returns:

the value for aDefinitionName as a Node. If no definition exists or it is not a Node, null is returned.

getDefinition

Node getDefinition(Node aNode,
                   String aDefinitionName,
                   Node aDefaultValue)

Gets a metadata definition as a Node from a Node with a fallback value if the definition does not exist.

Parameters:

aNode - the Node that has a metadata definition

aDefinitionName - the name of the metadata definition

aDefaultValue - fallback value if no definition exists

Returns:

the value for aDefinitionName as a Node. If no definition exists or it is not a Node, aDefaultValue is returned.

getDefinitions

List<Node> getDefinitions(Node aNode)

Gets all metadata definitions available for the current user on a Node

Parameters:

aNode - the Node that has a metadata definition

Returns:

a list of definitions on aNode, or empty list

Since:

Sitevision 4.2.3

addAlternative

void addAlternative(Node aNode,
                    String aDefinitionName,
                    String aAlternativeName)
             throws RepositoryException

Add an alternative to a definition

Parameters:

aNode - the Node where the metadata definition is located

aDefinitionName - the name of the metadata definition. May not be null or whitespace only

aAlternativeName - the name of the alternative (case in-sensitive). May not be null or whitespace only

Throws:

RepositoryException - if aNode is invalid, if aNode does not have a metadata definition named aDefinitionName, if it already contains an alternative named aAlternativeName, or if something else goes wrong

Since:

Sitevision 4.2.3

renameAlternative

void renameAlternative(Node aNode,
                       String aDefinitionName,
                       String aAlternativeName,
                       String aNewAlternativeName)
                throws RepositoryException

Rename an alternative for a definition

Parameters:

aNode - the Node where the metadata definition is located

aDefinitionName - the name of the metadata definition. May not be null or whitespace only

aAlternativeName - the name of the alternative (case in-sensitive). May not be null or whitespace only

aNewAlternativeName - the new name of the alternative. May not be null or whitespace only

Throws:

RepositoryException - if aNode is invalid, if aNode does not have a metadata definition named aDefinitionName, if it does not contain an alternative named aAlternativeName, if it already contains an alternative named aNewAlternativeName, or if something else goes wrong

Since:

Sitevision 8.1

removeAlternative

void removeAlternative(Node aNode,
                       String aDefinitionName,
                       String aAlternativeName)
                throws RepositoryException

Remove an alternative from a definition

Parameters:

aNode - the Node where the metadata definition is located

aDefinitionName - the name of the metadata definition. May not be null or whitespace only

aAlternativeName - the name of the alternative (case in-sensitive). May not be null or whitespace only

Throws:

RepositoryException - if aNode is invalid, if aNode does not have a metadata definition named aDefinitionName, if it does not contain an alternative named aAlternativeName, or if something else goes wrong

Since:

Sitevision 8.1