import java.io.Closeable;
import java.io.IOException;
-import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.xml.namespace.QName;
/**
- * A semi-structured content, with attributes, within a hierarchical structure.
+ * A semi-structured content, with attributes, within a hierarchical structure
+ * whose nodes are named.
*/
-public interface Content extends Iterable<Content>, Map<QName, Object> {
+public interface Content extends QualifiedData<Content> {
+ /** The path separator: '/' */
+ char PATH_SEPARATOR = '/';
- QName getName();
+ /** The base of a repository path. */
+ String ROOT_PATH = Character.toString(PATH_SEPARATOR);
String getPath();
- Content getParent();
-
- /*
- * ATTRIBUTES OPERATIONS
- */
-
- <A> Optional<A> get(QName key, Class<A> clss);
-
- Class<?> getType(QName key);
-
- boolean isMultiple(QName key);
-
- <A> List<A> getMultiple(QName key, Class<A> clss);
+ /** MUST be {@link Content#PATH_SEPARATOR}. */
+ default char getPathSeparator() {
+ return PATH_SEPARATOR;
+ }
/*
- * ATTRIBUTES OPERATION HELPERS
+ * CONTENT OPERATIONS
*/
- default boolean containsKey(QNamed key) {
- return containsKey(key.qName());
- }
-
- default <A> Optional<A> get(QNamed key, Class<A> clss) {
- return get(key.qName(), clss);
- }
-
- default Object get(QNamed key) {
- return get(key.qName());
- }
-
- default Object put(QNamed key, Object value) {
- return put(key.qName(), value);
- }
-
- default Object remove(QNamed key) {
- return remove(key.qName());
- }
-
- // TODO do we really need the helpers below?
+ /** Adds a new empty {@link Content} to this {@link Content}. */
+ Content add(QName name, QName... contentClass);
- default Object get(String key) {
- return get(unqualified(key));
+ default Content add(QName name, QNamed... contentClass) {
+ return add(name, toQNames(contentClass));
}
- default Object put(String key, Object value) {
- return put(unqualified(key), value);
- }
-
- default Object remove(String key) {
- return remove(unqualified(key));
- }
-
- @SuppressWarnings("unchecked")
- default <A> List<A> getMultiple(QName key) {
- Class<A> type;
- try {
- type = (Class<A>) getType(key);
- } catch (ClassCastException e) {
- throw new IllegalArgumentException("Requested type is not the default type");
- }
- List<A> res = getMultiple(key, type);
- return res;
-// if (res == null)
-// return null;
-// else {
-// if (res.isEmpty())
-// throw new IllegalStateException("Metadata " + key + " is not availabel as list of type " + type);
-// return res.get();
-// }
- }
-
- /*
- * CONTENT OPERATIONS
+ /**
+ * Adds a new {@link Content} to this {@link Content}, setting the provided
+ * attributes. The provided attributes can be used as hints by the
+ * implementation. In particular, setting {@link DName#getcontenttype} will
+ * imply that this content has a file semantic.
*/
-// default CompletionStage<Content> edit(Consumer<Content> work) {
-// return CompletableFuture.supplyAsync(() -> {
-// work.accept(this);
-// return this;
-// }).minimalCompletionStage();
-// }
-
- Content add(QName name, QName... classes);
+ default Content add(QName name, Map<QName, Object> attrs, QName... classes) {
+ Content child = add(name, classes);
+ putAll(attrs);
+ return child;
+ }
default Content add(String name, QName... classes) {
return add(unqualified(name), classes);
}
+ default Content add(String name, Map<QName, Object> attrs, QName... classes) {
+ return add(unqualified(name), attrs, classes);
+ }
+
void remove();
/*
return true;
}
+ /** AND */
+ default boolean isContentClass(QNamed... contentClass) {
+ return isContentClass(toQNames(contentClass));
+ }
+
/** OR */
default boolean hasContentClass(QName... contentClass) {
List<QName> contentClasses = getContentClasses();
return false;
}
- default boolean hasContentClass(QNamed contentClass) {
- return hasContentClass(contentClass.qName());
+ /** OR */
+ default boolean hasContentClass(QNamed... contentClass) {
+ return hasContentClass(toQNames(contentClass));
}
- /*
- * SIBLINGS
- */
-
- default int getSiblingIndex() {
- return 1;
+ static QName[] toQNames(QNamed... names) {
+ QName[] res = new QName[names.length];
+ for (int i = 0; i < names.length; i++)
+ res[i] = names[i].qName();
+ return res;
}
/*
* DEFAULT METHODS
*/
- default <A> A adapt(Class<A> clss) {
- throw new UnsupportedOperationException("Cannot adapt content " + this + " to " + clss.getName());
- }
-
default <C extends Closeable> C open(Class<C> clss) throws IOException {
throw new UnsupportedOperationException("Cannot open content " + this + " as " + clss.getName());
}
/*
* CHILDREN
*/
-
- default boolean hasChild(QName name) {
- for (Content child : this) {
- if (child.getName().equals(name))
- return true;
- }
- return false;
- }
-
- default boolean hasChild(QNamed name) {
- return hasChild(name.qName());
- }
-
default Content anyOrAddChild(QName name, QName... classes) {
Content child = anyChild(name);
if (child != null)
return anyOrAddChild(unqualified(name), classes);
}
- /** Any child with this name, or null if there is none */
- default Content anyChild(QName name) {
- for (Content child : this) {
- if (child.getName().equals(name))
- return child;
- }
- return null;
- }
-
- default List<Content> children(QName name) {
- List<Content> res = new ArrayList<>();
- for (Content child : this) {
- if (child.getName().equals(name))
- res.add(child);
- }
- return res;
- }
-
- default Optional<Content> soleChild(QName name) {
- List<Content> res = children(name);
- if (res.isEmpty())
- return Optional.empty();
- if (res.size() > 1)
- throw new IllegalStateException(this + " has multiple children with name " + name);
- return Optional.of(res.get(0));
- }
-
- default Content child(QName name) {
- return soleChild(name).orElseThrow();
- }
-
- default Content child(QNamed name) {
- return child(name.qName());
+ default Content soleOrAddChild(QName name, QName... classes) {
+ return soleChild(name).orElseGet(() -> this.add(name, classes));
}
/*
- * ATTR AS STRING
+ * CONTEXT
*/
- default String attr(QName key) {
- // TODO check String type?
- Object obj = get(key);
- if (obj == null)
- return null;
- return obj.toString();
- }
-
- default String attr(QNamed key) {
- return attr(key.qName());
- }
-
- default String attr(String key) {
- return attr(unqualified(key));
- }
-//
-// default String attr(Object key) {
-// return key != null ? attr(key.toString()) : attr(null);
-// }
-//
-// default <A> A get(Object key, Class<A> clss) {
-// return key != null ? get(key.toString(), clss) : get(null, clss);
-// }
+ /**
+ * A content within this repository
+ *
+ * @param path either an absolute path or a path relative to this content
+ */
+ Optional<Content> getContent(String path);
/*
* EXPERIMENTAL UNSUPPORTED
projects / lgpl / argeo-commons.git / blobdiff