KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > hp > hpl > jena > rdf > model > ModelSource


1 /*
2   (c) Copyright 2004, 2005 Hewlett-Packard Development Company, LP
3   [See end of file]
4   $Id: ModelSource.java,v 1.6 2005/02/21 12:14:11 andy_seaborne Exp $
5 */
6
7 package com.hp.hpl.jena.rdf.model;
8
9
10 /**
11     The revised and soon-to-be-core interface for sources of models,
12     typically generated from RDF descriptions.
13     
14     <p>ModelSources can supply models in a variety of ways.
15     
16     <ul>
17     <li>some fresh model of the kind this ModelSource supplies
18     <li>the particular model this ModelSource supplies
19     <li>a named model from the collection this ModelSource supplies
20     </ul>
21     
22     A ModelSource is free to "forget" named models if it so wishes;
23     for example, it may be a discard-if-getting-full cache.
24     
25     @author hedgehog
26 */
27 public interface ModelSource
28     {
29     /**
30         Answer this ModelSource's default model. Every ModelSource
31         has a default model. That model need not be created until the
32         first call on getModel. Multiple calls of getModel will
33         yield the *same* model. This method never returns <code>null</code>.
34     */
35     Model getModel();
36     
37     /**
38         Answer a Model that satisfies this ModelSource's shape. Different
39         calls may return different models, or they may all return the same
40         model. This method never returns <code>null</code>.
41     */
42     Model createModel();
43     
44     /**
45         Answer a model. Different ModelSources may implement this
46         in very different ways - ModelSource imposes few constraints
47         other than the result is a proper Model. A ModelSource may
48         use the name to identify an existing Model and re-use it,
49         or it may create a fresh Model each time.
50         
51         <p>It is expected that uses of different names will answer
52         different models (different in the strong sense of not having
53         the same underlying graph, too).
54         
55         <p>If the ModelSource does not have a model with this name,
56         and if it is not prepared to create one, it should throw a
57         DoesNotExistException. This method never returns <code>null</code>.
58     */
59     Model openModel( String JavaDoc name );
60
61     /**
62         Answer the model named by <code>string</code> in this ModelSource,
63         if it [still] has one, or <code>null</code> if there isn't one.
64         The ModelSource should <i>not</i> create a fresh model if it
65         doesn't already have one.
66     */
67     Model openModelIfPresent( String JavaDoc string );
68     }
69
70 /*
71     (c) Copyright 2004, 2005 Hewlett-Packard Development Company, LP
72     All rights reserved.
73     
74     Redistribution and use in source and binary forms, with or without
75     modification, are permitted provided that the following conditions
76     are met:
77     
78     1. Redistributions of source code must retain the above copyright
79        notice, this list of conditions and the following disclaimer.
80     
81     2. Redistributions in binary form must reproduce the above copyright
82        notice, this list of conditions and the following disclaimer in the
83        documentation and/or other materials provided with the distribution.
84     
85     3. The name of the author may not be used to endorse or promote products
86        derived from this software without specific prior written permission.
87     
88     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
89     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
91     IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
92     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
93     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
94     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
95     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
96     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
97     THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
98 */
Popular Tags