001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.http.commons.api.rdf;
019
020import javax.ws.rs.core.UriInfo;
021
022import com.hp.hpl.jena.rdf.model.Resource;
023import org.fcrepo.kernel.api.models.FedoraResource;
024import org.fcrepo.kernel.api.identifiers.IdentifierConverter;
025
026import com.hp.hpl.jena.rdf.model.Model;
027
028/**
029 * Helper to generate an RDF model for a FedoraResourceImpl that (likely) creates
030 * relations from our resource to other HTTP components
031 *
032 * @author awoods
033 */
034public interface UriAwareResourceModelFactory {
035
036    /**
037     * Given a resource, the UriInfo and a way to generate graph subjects,
038     * create a model with triples to inject into an RDF response for the
039     * resource (e.g. to add HATEOAS links)
040     *
041     * @param resource the resource
042     * @param uriInfo the uri info
043     * @param idTranslator the id translator
044     * @return model containing triples for the given resource
045     */
046    Model createModelForResource(final FedoraResource resource,
047            final UriInfo uriInfo, final IdentifierConverter<Resource,FedoraResource> idTranslator);
048}