1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.connector.federation;
25
26 import net.jcip.annotations.Immutable;
27 import org.modeshape.graph.ExecutionContext;
28 import org.modeshape.graph.Location;
29
30 /**
31 * Interface for the components that compute the {@link ProjectedNode} for a given location. Implementations may be provided for
32 * different configurations of {@link FederatedWorkspace#getProjections() projections}.
33 */
34 @Immutable
35 interface Projector {
36
37 /**
38 * Project the supplied location in the federated repository into the equivalent projected node(s).
39 *
40 * @param context the execution context in which the content is being accessed; may not be null
41 * @param location the location in the federated repository; may not be null
42 * @param requiresUpdate true if the operation for which this projection is needed will update the content in some way, or
43 * false if read-only operations will be performed
44 * @return the projected node, or null if the node does not exist in any projection or if the operation requires update and no
45 * writable projection applies
46 */
47 ProjectedNode project( ExecutionContext context,
48 Location location,
49 boolean requiresUpdate );
50 }