1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.metapath.item.node;
28
29 import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter;
30 import gov.nist.secauto.metaschema.core.model.IAssemblyInstance;
31 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 /**
36 * A marker interface used to expose root node functionality for an assembly
37 * node that has root information.
38 */
39 public interface IRootAssemblyNodeItem extends IAssemblyNodeItem {
40
41 /**
42 * Get the name of this node.
43 * <p>
44 * This overrides the default behavior using the root name for the assembly.
45 */
46 @Override
47 default String getName() {
48 return ObjectUtils.requireNonNull(getDefinition().getRootName());
49 }
50
51 /**
52 * Get the parent document node item for this root.
53 *
54 * @return the parent document item
55 */
56 @NonNull
57 IDocumentNodeItem getDocumentNodeItem();
58
59 @Override
60 @NonNull
61 default IDocumentNodeItem getParentNodeItem() {
62 return getDocumentNodeItem();
63 }
64
65 @Override
66 default IAssemblyNodeItem getParentContentNodeItem() {
67 // there is no assembly parent
68 return null;
69 }
70
71 @Override
72 default IAssemblyInstance getInstance() {
73 // there is no instance
74 return null;
75 }
76
77 @Override
78 default IRootAssemblyNodeItem getNodeItem() {
79 return this;
80 }
81
82 @Override
83 default int getPosition() {
84 // a root is always in the first position
85 return 1;
86 }
87
88 @Override
89 default String format(@NonNull IPathFormatter formatter) {
90 return formatter.formatRootAssembly(this);
91 }
92 }