systems.dmx.facets

Interface FacetsService

Show UML class diagram

All Known Implementing Classes:

FacetsPlugin

public interface FacetsService

Method Summary

Modifier and Type	Method and Description
void	addFacetTypeToTopic(long topicId, String facetTypeUri)
RelatedTopic	getFacet(DMXObject object, String facetTypeUri) Retrieves a facet value.
RelatedTopic	getFacet(long topicId, String facetTypeUri)
List<RelatedTopic>	getFacets(DMXObject object, String facetTypeUri) Retrieves the values of a multi-facet.
List<RelatedTopic>	getFacets(long topicId, String facetTypeUri)
Topic	getFacettedTopic(long topicId, List<String> facetTypeUris)
boolean	hasFacet(long topicId, String facetTypeUri, long facetTopicId)
void	updateFacet(DMXObject object, String facetTypeUri, FacetValueModel value) Updates a facet.
void	updateFacet(long topicId, String facetTypeUri, FacetValueModel value)

Method Detail

getFacet

RelatedTopic getFacet(long topicId,
                      String facetTypeUri)

getFacet

RelatedTopic getFacet(DMXObject object,
                      String facetTypeUri)

Retrieves a facet value. ### TODO: rename to getFacetValue?

Parameters:

object - The facetted object: a topic, association, a type ...

facetTypeUri - URI of the facet type.

Returns:

The retrieved facet value (including its child topics) or null if no such topic extists.

getFacets

List<RelatedTopic> getFacets(long topicId,
                             String facetTypeUri)

getFacets

List<RelatedTopic> getFacets(DMXObject object,
                             String facetTypeUri)

Retrieves the values of a multi-facet. ### TODO: rename to getFacetValues?

Parameters:

object - The facetted object: a topic, association, a type ...

facetTypeUri - URI of the facet type.

Returns:

The retrieved facet values (including their child topics). The list may be empty.

getFacettedTopic

Topic getFacettedTopic(long topicId,
                       List<String> facetTypeUris)

addFacetTypeToTopic

void addFacetTypeToTopic(long topicId,
                         String facetTypeUri)

updateFacet

void updateFacet(long topicId,
                 String facetTypeUri,
                 FacetValueModel value)

updateFacet

void updateFacet(DMXObject object,
                 String facetTypeUri,
                 FacetValueModel value)

Updates a facet.

Parameters:

object - The facetted object: a topic, association, a type ...

facetTypeUri - URI of the facet type.

value - The new facet value.

hasFacet

boolean hasFacet(long topicId,
                 String facetTypeUri,
                 long facetTopicId)