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.model;
028
029import javax.xml.namespace.QName;
030
031import edu.umd.cs.findbugs.annotations.NonNull;
032import edu.umd.cs.findbugs.annotations.Nullable;
033
034/**
035 * This marker interface is used to identify a field or assembly instance that
036 * is a member of an assembly's model.
037 */
038public interface IModelInstance extends IInstance {
039  @Override
040  IModelContainer getParentContainer();
041
042  /**
043   * Retrieve the Metaschema assembly definition on which this instance is
044   * declared.
045   *
046   * @return the parent Metaschema assembly definition
047   */
048  @Override
049  IAssemblyDefinition getContainingDefinition();
050
051  /**
052   * Get the name used for the associated element wrapping a collection of
053   * elements in XML. This value is required when {@link #getXmlGroupAsBehavior()}
054   * = {@link XmlGroupAsBehavior#GROUPED}. This name will be the element name
055   * wrapping a collection of elements.
056   *
057   * @return the groupAs QName or {@code null} if no name is configured, such as
058   *         when {@link #getMaxOccurs()} = 1.
059   */
060  @Nullable
061  default QName getXmlGroupAsQName() {
062    QName retval = null;
063    if (XmlGroupAsBehavior.GROUPED.equals(getXmlGroupAsBehavior())) {
064      String namespace = getGroupAsXmlNamespace();
065      if (namespace != null) {
066        retval = new QName(namespace, getGroupAsName());
067      } else {
068        retval = new QName(getGroupAsName());
069      }
070    }
071    return retval;
072  }
073
074  /**
075   * Get the minimum cardinality for this associated instance. This value must be
076   * less than or equal to the maximum cardinality returned by
077   * {@link #getMaxOccurs()}.
078   *
079   * @return {@code 0} or a positive integer value
080   */
081  int getMinOccurs();
082
083  /**
084   * Get the maximum cardinality for this associated instance. This value must be
085   * greater than or equal to the minimum cardinality returned by
086   * {@link #getMinOccurs()}, or {@code -1} if unbounded.
087   *
088   * @return a positive integer value or {@code -1} if unbounded
089   */
090  int getMaxOccurs();
091
092  /**
093   * Get the name provided for grouping. An instance in Metaschema must have a
094   * group name if the instance has a cardinality greater than {@code 1}.
095   *
096   * @return the group-as name or {@code null} if no name is configured, such as
097   *         when {@link #getMaxOccurs()} = 1
098   */
099  @Nullable
100  String getGroupAsName();
101
102  /**
103   * Retrieve the XML namespace for this group.
104   *
105   * @return the XML namespace or {@code null} if no namespace is used
106   */
107  @Nullable
108  String getGroupAsXmlNamespace();
109
110  /**
111   * Gets the configured JSON group-as strategy. A JSON group-as strategy is only
112   * required when {@link #getMaxOccurs()} > 1.
113   *
114   * @return the JSON group-as strategy, or {@code JsonGroupAsBehavior#NONE} if
115   *         {@link #getMaxOccurs()} = 1
116   */
117  @NonNull
118  JsonGroupAsBehavior getJsonGroupAsBehavior();
119
120  /**
121   * Gets the configured XML group-as strategy. A XML group-as strategy is only
122   * required when {@link #getMaxOccurs()} > 1.
123   *
124   * @return the JSON group-as strategy, or {@code XmlGroupAsBehavior#UNGROUPED}
125   *         if {@link #getMaxOccurs()} = 1
126   */
127  @NonNull
128  XmlGroupAsBehavior getXmlGroupAsBehavior();
129}