Package systems.dmx.core.model.facets

Interface FacetValueModel

All Superinterfaces:

ChildTopicsModel, Iterable<String>, JSONEnabled

public interface FacetValueModel
extends ChildTopicsModel

A facet value as used in update facet calls. Used for both, single-valued facets and multiple-valued facets.

Method Summary

Modifier and Type	Method	Description
FacetValueModel	addDeletionRef(long assocId)	Adds a topic deletion reference to a multiple-valued facet.
FacetValueModel	addRef(long refTopicId)	Adds a by-ID topic reference to a multiple-valued facet.
FacetValueModel	addRef(String refTopicUri)	Adds a by-URI topic reference to a multiple-valued facet.
RelatedTopicModel	getTopic()	Accesses a single-valued facet.
List<? extends RelatedTopicModel>	getTopics()	Accesses a multiple-valued facet.
FacetValueModel	set(Object value)	Convenience method to put a *simple* value in a single-valued facet.
FacetValueModel	set(List<RelatedTopicModel> values)	Sets the values of a multiple-valued facet.
FacetValueModel	set(ChildTopicsModel value)	Convenience method to put a *composite* value in a single-valued facet.
FacetValueModel	set(RelatedTopicModel value)	Puts a value in a single-valued facet.
FacetValueModel	set(TopicModel value)
FacetValueModel	setDeletionRef(long refTopicId)	Puts a by-ID topic deletion reference in a single-valued facet.
FacetValueModel	setDeletionRef(String refTopicUri)	Puts a by-URI topic deletion reference in a single-valued facet.
FacetValueModel	setRef(long refTopicId)	Puts a by-ID topic reference in a single-valued facet.
FacetValueModel	setRef(String refTopicUri)	Puts a by-URI topic reference in a single-valued facet.

Methods inherited from interface systems.dmx.core.model.ChildTopicsModel

add, add, add, add, addDeletionRef, addRef, addRef, addRef, addRef, clone, get, getBoolean, getBoolean, getChildTopics, getChildTopics, getDouble, getDouble, getInt, getInt, getLong, getLong, getString, getString, getTopic, getTopicOrNull, getTopics, getTopicsOrNull, getValue, getValue, has, remove, remove, set, set, set, set, set, setDeletionRef, setDeletionRef, setRef, setRef, setRef, setRef, size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface systems.dmx.core.JSONEnabled

dump, toJSON

Method Detail

getTopic

RelatedTopicModel getTopic()

Accesses a single-valued facet.

getTopics

List<? extends RelatedTopicModel> getTopics()

Accesses a multiple-valued facet.

set

FacetValueModel set(RelatedTopicModel value)

Puts a value in a single-valued facet.

set

FacetValueModel set(TopicModel value)

set

FacetValueModel set(Object value)

Convenience method to put a *simple* value in a single-valued facet.

set

FacetValueModel set(ChildTopicsModel value)

Convenience method to put a *composite* value in a single-valued facet.

setRef

FacetValueModel setRef(long refTopicId)

Puts a by-ID topic reference in a single-valued facet. An existing reference is overwritten.

setRef

FacetValueModel setRef(String refTopicUri)

Puts a by-URI topic reference in a single-valued facet. An existing reference is overwritten.

setDeletionRef

FacetValueModel setDeletionRef(long refTopicId)

Puts a by-ID topic deletion reference in a single-valued facet. An existing value is overwritten.

setDeletionRef

FacetValueModel setDeletionRef(String refTopicUri)

Puts a by-URI topic deletion reference in a single-valued facet. An existing value is overwritten.

set

FacetValueModel set(List<RelatedTopicModel> values)

Sets the values of a multiple-valued facet.

addRef

FacetValueModel addRef(long refTopicId)

Adds a by-ID topic reference to a multiple-valued facet.

addRef

FacetValueModel addRef(String refTopicUri)

Adds a by-URI topic reference to a multiple-valued facet.

addDeletionRef

FacetValueModel addDeletionRef(long assocId)

Adds a topic deletion reference to a multiple-valued facet. Note: the topic to be deleted is referred to by association ID. The topic might occur several times in the same multi-value, so topic ID/URI would not be unique.