senselogic.sitevision.api.metadata.builder

Interface RelatedValueBuilder

All Superinterfaces:

Builder<RelatedValue>

@Requireable(value="RelatedValueBuilder")
public interface RelatedValueBuilder
extends Builder<RelatedValue>

Builder to create RelatedValue instances that can be used to set related metadata.

RelatedValueBuilder has one mandatory attribute:

• values - The related values. Must be non-empty.

Using the RelatedValueBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the RelatedValueBuilder
2. Add a value
3. Possibly add more values
4. Do build

When you have built a RelatedValue instance, you can re-use the RelatedValueBuilder to build more instances. Something like:

1. Clear values
2. Add a value
3. Possibly add more values
4. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

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

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
RelatedValueBuilder	addLinkValue(LinkValue aLinkValue) Adds a link value.
RelatedValueBuilder	addText(String aText) Adds a text value.
RelatedValueBuilder	addUser(Node aUserNode) Adds a user value.
RelatedValue	build() Creates a RelatedValue instance using current state of this builder.
RelatedValueBuilder	clearValues() Removes all currently added values.

Method Detail

addLinkValue

RelatedValueBuilder addLinkValue(LinkValue aLinkValue)
                          throws IllegalArgumentException

Adds a link value.

Parameters:

aLinkValue - the link value to add

Returns:

this builder

Throws:

IllegalArgumentException - if aLinkValue is null or not an instance created via LinkValueBuilder

addUser

RelatedValueBuilder addUser(Node aUserNode)
                     throws IllegalArgumentException

Adds a user value.

Parameters:

aUserNode - the user node to add (a node with primary node type sv:user or sv:simpleUser)

Returns:

this builder

Throws:

IllegalArgumentException - if aUserNode is null or an invalid user node (e.g. sv:systemUser - Anonymous, System, Indexer, Validator or Extractor)

addText

RelatedValueBuilder addText(String aText)

Adds a text value.

Parameters:

aText - the text to add. A null or whitespace-only value will be completely ignored.

Returns:

this builder

clearValues

RelatedValueBuilder clearValues()

Removes all currently added values.

Returns:

this builder

build

RelatedValue build()
            throws IllegalStateException

Creates a RelatedValue instance using current state of this builder.

Specified by:

build in interface Builder<RelatedValue>

Returns:

a related value

Throws:

IllegalStateException - if the builder contains no values.