Package: ListDescriptor

ListDescriptor

Coverage

1: /**
2: * Copyright (C) 2016 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15: package cz.cvut.kbss.ontodriver.descriptor;
16:
17: import cz.cvut.kbss.ontodriver.model.Assertion;
18: import cz.cvut.kbss.ontodriver.model.NamedResource;
19:
20: import java.net.URI;
21:
22: /**
23: * This interface declares the basic methods for working with sequences in JOPA.
24: * @author kidney
25: *
26: */
27: public interface ListDescriptor {
28:
29:         /**
30:          * Gets context in which the list is stored.
31:          *
32:          * @return Context URI
33:          */
34:         public abstract URI getContext();
35:
36:         /**
37:          * Sets context of the list.
38:          *
39:          * @param context
40:          * Context URI, can be {@code null}
41:          */
42:         public abstract void setContext(URI context);
43:
44:         /**
45:          * Gets owner of the list. </p>
46:          *
47:          * That is, the named resource which is at the head of the list. In object
48:          * model, it is the owning entity.
49:          *
50:          * @return List owner
51:          */
52:         public abstract NamedResource getListOwner();
53:
54:         /**
55:          * Gets the property assertion which connects the list to its owner.
56:          *
57:          * @return Property assertion
58:          * @see #getListOwner()
59:          */
60:         public abstract Assertion getListProperty();
61:
62:         /**
63:          * Gets the property assertion which connects the list nodes to each other.
64:          *
65:          * @return Property assertion
66:          */
67:         public abstract Assertion getNextNode();
68:
69: }