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 java.util.Collection;
030import java.util.List;
031
032import edu.umd.cs.findbugs.annotations.NonNull;
033import edu.umd.cs.findbugs.annotations.Nullable;
034
035/**
036 * Indicates that the Metaschema type that has a complex model that can contain
037 * field and assembly instances.
038 */
039public interface IModelContainer extends IContainer {
040  /**
041   * Retrieve the Metaschema definition containing this container.
042   *
043   * @return the containing Metaschema definition
044   */
045  @Override
046  @NonNull
047  IAssemblyDefinition getOwningDefinition();
048
049  /**
050   * Get the model instance contained within the model with the associated use
051   * name.
052   *
053   * @param name
054   *          the use name of the model instance
055   * @return the matching model instance, or {@code null} if no match was found
056   * @see INamedModelInstance#getUseName()
057   */
058  @Nullable
059  INamedModelInstance getModelInstanceByName(String name);
060
061  /**
062   * Get all named model instances within the container.
063   *
064   * @return an ordered mapping of use name to model instance
065   */
066  @NonNull
067  Collection<? extends INamedModelInstance> getNamedModelInstances();
068
069  /**
070   * Get all field instances within the container.
071   *
072   * @return a mapping of use name to field instance
073   */
074  @NonNull
075  Collection<? extends IFieldInstance> getFieldInstances();
076
077  /**
078   * Get the field instance contained within the model with the associated use
079   * name.
080   *
081   * @param name
082   *          the use name of the field instance
083   * @return the matching field instance, or {@code null} if no match was found
084   * @see IFieldInstance#getUseName()
085   */
086  @Nullable
087  IFieldInstance getFieldInstanceByName(String name);
088
089  /**
090   * Get all assembly instances within the container.
091   *
092   * @return a mapping of use name to assembly instance
093   */
094  @NonNull
095  Collection<? extends IAssemblyInstance> getAssemblyInstances();
096
097  /**
098   * Get the assembly instance contained within the model with the associated use
099   * name.
100   *
101   * @param name
102   *          the use name of the assembly instance
103   * @return the matching assembly instance, or {@code null} if no match was found
104   * @see IAssemblyInstance#getUseName()
105   */
106  @Nullable
107  IAssemblyInstance getAssemblyInstanceByName(String name);
108
109  /**
110   * Get all choice instances within the container.
111   *
112   * @return a list of choice instances
113   */
114  @NonNull
115  List<? extends IChoiceInstance> getChoiceInstances();
116
117  /**
118   * Get all model instances within the container.
119   *
120   * @return an ordered collection of model instances
121   */
122  @NonNull
123  Collection<? extends IModelInstance> getModelInstances();
124}