de.deepamehta.plugins.facets.service
Interface FacetsService

Show UML class diagram
All Superinterfaces:
PluginService
All Known Implementing Classes:
FacetsPlugin

public interface FacetsService
extends PluginService


Method Summary
 void addFacetTypeToTopic(long topicId, String facetTypeUri)
           
 Topic getFacet(DeepaMehtaObject object, String facetTypeUri)
          Retrieves a facet value.
 Topic getFacet(long topicId, String facetTypeUri)
           
 ResultList<RelatedTopic> getFacets(DeepaMehtaObject object, String facetTypeUri)
          Retrieves the values of a multi-facet.
 ResultList<RelatedTopic> getFacets(long topicId, String facetTypeUri)
           
 Topic getFacettedTopic(long topicId, List<String> facetTypeUris)
           
 boolean hasFacet(long topicId, String facetTypeUri, long facetTopicId)
           
 void updateFacet(DeepaMehtaObject object, String facetTypeUri, FacetValue value)
          Updates a facet.
 void updateFacet(long topicId, String facetTypeUri, FacetValue value)
           
 

Method Detail

getFacet

Topic getFacet(long topicId,
               String facetTypeUri)

getFacet

Topic getFacet(DeepaMehtaObject object,
               String facetTypeUri)
Retrieves a facet value. ### TODO: rename to getFacetValue ### TODO: add fetchComposite parameter

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

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

getFacets

ResultList<RelatedTopic> getFacets(DeepaMehtaObject object,
                                   String facetTypeUri)
Retrieves the values of a multi-facet. ### TODO: rename to getFacetValues ### TODO: add fetchComposite parameter

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,
                 FacetValue value)

updateFacet

void updateFacet(DeepaMehtaObject object,
                 String facetTypeUri,
                 FacetValue value)
Updates a facet.

Parameters:
object - The facetted object: a topic, association, a type ...
facetTypeUri - URI of the facet type.
facetValue - The new facet value.

hasFacet

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


Copyright © 2015. All Rights Reserved.