1 /*
2 * Copyright (c) 2009-2012 The 99 Software Foundation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22 package org.nnsoft.sameas4j;
23
24 import java.net.URI;
25
26 import org.nnsoft.sameas4j.cache.Cache;
27
28 /**
29 * It models the methods that a <a href="http://sameas.org">sameas.org</a>
30 * client must expose.
31 */
32 public interface SameAsService {
33
34 /**
35 * It returns a set of <code>URI</code> identifying equivalent
36 * resources to the input <code>URI</code>.
37 *
38 * @param uri the URI for which the equivalence has to be known.
39 * @return the URI equivalence.
40 * @throws SameAsServiceException if an HTTP or JSON parse error occurs.
41 */
42 Equivalence getDuplicates(URI uri) throws SameAsServiceException;
43
44 /**
45 * It returns a list of {@link org.nnsoft.sameas4j.Equivalence} objects
46 * identifying equivalent <code>URI<code> for every possible co-reference
47 * match.
48 *
49 * See also the official <a href="http://sameas.org/about.php">SameAs.org documentation</a>.
50 *
51 * @param keyword the keyword for which the equivalence has to be known.
52 * @return a list of possible equivalences.
53 * @throws SameAsServiceException if an HTTP or JSON parse error occurs.
54 */
55 EquivalenceList getDuplicates(String keyword) throws SameAsServiceException;
56
57 /**
58 *
59 * @param cache
60 */
61 void setCache(Cache cache);
62
63 }