001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.metapath.item.node;
028
029import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter;
030
031import java.net.URI;
032import java.util.List;
033import java.util.stream.Collectors;
034import java.util.stream.Stream;
035
036import edu.umd.cs.findbugs.annotations.NonNull;
037import edu.umd.cs.findbugs.annotations.Nullable;
038
039public interface IDocumentNodeItem extends INodeItem, IFeatureNoDataItem {
040  @Override
041  default NodeItemType getNodeItemType() {
042    return NodeItemType.DOCUMENT;
043  }
044
045  @Override
046  default IDocumentNodeItem getNodeItem() {
047    return this;
048  }
049
050  @Override
051  default IModelNodeItem<?, ?> getParentContentNodeItem() {
052    // there is no parent
053    return null;
054  }
055
056  @Override
057  default INodeItem getParentNodeItem() {
058    // there is no parent
059    return null;
060  }
061
062  /**
063   * Get the URI associated with this document.
064   *
065   * @return the document's URI or {@code null} if unavailable
066   */
067  @Nullable
068  URI getDocumentUri();
069
070  @Override
071  default URI getBaseUri() {
072    return getDocumentUri();
073  }
074
075  /**
076   * Get the root items having the provided {@code name}.
077   *
078   * @param name
079   *          the root item's name to retrieve
080   * @return a list of matching root items
081   */
082  default List<? extends IRootAssemblyNodeItem> getRootNodeItemByName(@NonNull String name) {
083    List<? extends IModelNodeItem<?, ?>> result = getModelItemsByName(name);
084    return result.stream().flatMap(item -> {
085      IRootAssemblyNodeItem retval = null;
086      if (item instanceof IRootAssemblyNodeItem) {
087        retval = (IRootAssemblyNodeItem) item;
088      }
089
090      return retval == null ? null : Stream.of(retval);
091    }).collect(Collectors.toUnmodifiableList());
092  }
093
094  @Override
095  default String format(@NonNull IPathFormatter formatter) {
096    return formatter.formatDocument(this);
097  }
098
099  @Override
100  default <RESULT, CONTEXT> RESULT accept(@NonNull INodeItemVisitor<RESULT, CONTEXT> visitor, CONTEXT context) {
101    return visitor.visitDocument(this, context);
102  }
103
104}