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;
031import java.util.Map;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035public interface IModelContainerSupport<
036    MI extends IModelInstance,
037    NMI extends INamedModelInstance,
038    FI extends IFieldInstance,
039    AI extends IAssemblyInstance,
040    CI extends IChoiceInstance> {
041
042  /**
043   * Get a listing of all model instances.
044   *
045   * @return the listing
046   */
047  @NonNull
048  Collection<MI> getModelInstances();
049
050  /**
051   * Get a mapping of all named model instances, mapped from their effective name
052   * to the instance.
053   *
054   * @return the mapping
055   */
056  @NonNull
057  Map<String, NMI> getNamedModelInstanceMap();
058
059  /**
060   * Get a mapping of all field instances, mapped from their effective name to the
061   * instance.
062   *
063   * @return the mapping
064   */
065  @NonNull
066  Map<String, FI> getFieldInstanceMap();
067
068  /**
069   * Get a mapping of all assembly instances, mapped from their effective name to
070   * the instance.
071   *
072   * @return the mapping
073   */
074  @NonNull
075  Map<String, AI> getAssemblyInstanceMap();
076
077  /**
078   * Get a listing of all choice instances.
079   *
080   * @return the listing
081   */
082  @NonNull
083  List<CI> getChoiceInstances();
084}