systems.dmx.facets.FacetsPlugin Maven / Gradle / Ivy

Go to download
package systems.dmx.facets;

import static systems.dmx.core.Constants.*;
import static systems.dmx.facets.Constants.*;
import systems.dmx.core.Assoc;
import systems.dmx.core.CompDef;
import systems.dmx.core.DMXObject;
import systems.dmx.core.RelatedTopic;
import systems.dmx.core.Topic;
import systems.dmx.core.model.ChildTopicsModel;
import systems.dmx.core.model.RelatedTopicModel;
import systems.dmx.core.model.facets.FacetValueModel;
import systems.dmx.core.osgi.PluginActivator;
import systems.dmx.core.service.Transactional;
import systems.dmx.core.util.DMXUtils;

import org.codehaus.jettison.json.JSONObject;

import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.Produces;
import javax.ws.rs.Consumes;

import java.util.List;
import java.util.logging.Logger;



// ### TODO: support custom assoc types also for facets.
// Some compDef.getChildTypeUri() calls must be replaced by compDef.getCompDefUri().
@Path("/facet")
@Consumes("application/json")
@Produces("application/json")
public class FacetsPlugin extends PluginActivator implements FacetsService {

    // ---------------------------------------------------------------------------------------------- Instance Variables

    private Logger logger = Logger.getLogger(getClass().getName());

    // -------------------------------------------------------------------------------------------------- Public Methods

    // === FacetsService ===

    @GET
    @Path("/{facet_type_uri}/topic/{id}")
    @Override
    public RelatedTopic getFacet(@PathParam("id") long topicId, @PathParam("facet_type_uri") String facetTypeUri) {
        return getFacet(dmx.getTopic(topicId), facetTypeUri);
    }

    @Override
    public RelatedTopic getFacet(DMXObject object, String facetTypeUri) {
        // ### TODO: integrity check: is the object an instance of that facet type?
        return fetchChildTopic(object, getCompDef(facetTypeUri));
    }

    // ---

    @GET
    @Path("/multi/{facet_type_uri}/topic/{id}")
    @Override
    public List getFacets(@PathParam("id") long topicId,
                                        @PathParam("facet_type_uri") String facetTypeUri) {
        return getFacets(dmx.getTopic(topicId), facetTypeUri);
    }

    @Override
    public List getFacets(DMXObject object, String facetTypeUri) {
        // ### TODO: integrity check: is the object an instance of that facet type?
        return fetchChildTopics(object, getCompDef(facetTypeUri));
    }

    // ---

    @GET
    @Path("/topic/{id}")
    @Override
    public Topic getFacettedTopic(@PathParam("id") long topicId,
                                  @QueryParam("facet_type_uri") List facetTypeUris) {
        try {
            Topic topic = dmx.getTopic(topicId);
            ChildTopicsModel childTopics = topic.getChildTopics().getModel();
            for (String facetTypeUri : facetTypeUris) {
                String childTypeUri = getChildTypeUri(facetTypeUri);
                if (!isMultiFacet(facetTypeUri)) {
                    Topic value = getFacet(topic, facetTypeUri);
                    if (value != null) {
                        childTopics.set(childTypeUri, value.getModel());
                    }
                } else {
                    List values = getFacets(topic, facetTypeUri);
                    // Note: without the type witness the generic set() method (which takes an Object) would be called
                    childTopics.set(childTypeUri, DMXUtils.toModelList(values));
                }
            }
            return topic;
        } catch (Exception e) {
            throw new RuntimeException("Getting facetted topic " + topicId + " failed, facetTypeUris=" + facetTypeUris,
                e);
        }
    }

    @POST
    @Path("/{facet_type_uri}/topic/{id}")
    @Transactional
    @Override
    public void addFacetTypeToTopic(@PathParam("id") long topicId, @PathParam("facet_type_uri") String facetTypeUri) {
        dmx.createAssoc(mf.newAssocModel(INSTANTIATION,
            mf.newTopicPlayerModel(topicId,      INSTANCE),
            mf.newTopicPlayerModel(facetTypeUri, FACET)
        ));
    }

    // ---

    @PUT
    @Path("/{facet_type_uri}/topic/{id}")
    @Transactional
    @Override
    public void updateFacet(@PathParam("id") long topicId, @PathParam("facet_type_uri") String facetTypeUri,
                                                                                        FacetValueModel value) {
        try {
            updateFacet(dmx.getTopic(topicId), facetTypeUri, value);
        } catch (Exception e) {
            throw new RuntimeException("Updating facet \"" + facetTypeUri + "\" of topic " + topicId +
                " failed, value=" + value, e);
        }
    }

    @Override
    public void updateFacet(DMXObject object, String facetTypeUri, FacetValueModel value) {
        object.updateChildTopics(value, getCompDef(facetTypeUri));
    }

    // ---

    // Note: there is a similar private method in DMXObjectImpl:
    // fetchChildTopic(CompDef compDef, long childTopicId)
    // ### TODO: Extend DMXObject interface by hasChildTopic()?
    @Override
    public boolean hasFacet(long topicId, String facetTypeUri, long facetTopicId) {
        String assocTypeUri = getCompDef(facetTypeUri).getInstanceLevelAssocTypeUri();
        Assoc assoc = dmx.getAssocBetweenTopicAndTopic(assocTypeUri, topicId, facetTopicId, PARENT, CHILD);
        return assoc != null;
    }

    // ------------------------------------------------------------------------------------------------- Private Methods

    /**
     * Fetches and returns a child topic or null if no such topic extists.
     * 
     * Note: There is a principal copy in DMXObjectImpl but here the precondition is different:
     * The given comp def must not necessarily originate from the given object's type definition.
     * ### TODO: meanwhile we have the ValueStorage. Can we use its method instead?
     */
    private RelatedTopic fetchChildTopic(DMXObject object, CompDef compDef) {
        String assocTypeUri  = compDef.getInstanceLevelAssocTypeUri();
        String othersTypeUri = compDef.getChildTypeUri();
        return object.getRelatedTopic(assocTypeUri, PARENT, CHILD, othersTypeUri);
    }

    /**
     * Fetches and returns child topics.
     * 
     * Note: There is a principal copy in DMXObjectImpl but here the precondition is different:
     * The given comp def must not necessarily originate from the given object's type definition.
     * ### TODO: meanwhile we have the ValueStorage. Can we use its method instead?
     */
    private List fetchChildTopics(DMXObject object, CompDef compDef) {
        String assocTypeUri  = compDef.getInstanceLevelAssocTypeUri();
        String othersTypeUri = compDef.getChildTypeUri();
        return object.getRelatedTopics(assocTypeUri, PARENT, CHILD, othersTypeUri);
    }

    // ---

    private boolean isMultiFacet(String facetTypeUri) {
        return getCompDef(facetTypeUri).getChildCardinalityUri().equals(MANY);
    }

    private String getChildTypeUri(String facetTypeUri) {
        return getCompDef(facetTypeUri).getChildTypeUri();
    }

    private CompDef getCompDef(String facetTypeUri) {
        // Note: a facet type has exactly *one* comp def
        return dmx.getTopicType(facetTypeUri).getCompDefs().iterator().next();
    }
}