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