Package: ListDescriptor

ListDescriptor

Coverage

1: /**
2: * Copyright (C) 2016 Czech Technical University in Prague
3: * <p>
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: * <p>
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: */
25: public interface ListDescriptor {
26:
27: /**
28: * Gets context in which the list is stored.
29: *
30: * @return Context URI, {@code null} if it is not set and the default is assumed
31: */
32: URI getContext();
33:
34: /**
35: * Sets context of the list.
36: *
37: * @param context Context URI, can be {@code null}
38: */
39: void setContext(URI context);
40:
41: /**
42: * Gets owner of the list.
43: * <p>
44: * That is, the named resource which is at the head of the list. In object
45: * model, it is the owning entity.
46: *
47: * @return List owner
48: */
49: NamedResource getListOwner();
50:
51: /**
52: * Gets the property assertion which connects the list to its owner.
53: *
54: * @return Property assertion
55: * @see #getListOwner()
56: */
57: Assertion getListProperty();
58:
59: /**
60: * Gets the property assertion which connects the list nodes to each other.
61: *
62: * @return Property assertion
63: */
64: Assertion getNextNode();
65: }