Serialized Form

Package gov.niem.tools.api.core.exceptions

Exception Class gov.niem.tools.api.core.exceptions.BadRequestException

class BadRequestException extends org.springframework.web.server.ResponseStatusException implements Serializable

Exception Class gov.niem.tools.api.core.exceptions.NoContentException

class NoContentException extends org.springframework.web.server.ResponseStatusException implements Serializable

Package gov.niem.tools.api.db.base

Class gov.niem.tools.api.db.base.BaseEntity

class BaseEntity extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

A user which created an entity.

createdDate

LocalDateTime createdDate

A date on which an entity was created.

id

Long id

A unique, auto-generated identifier for an entity.

lastModifiedBy

String lastModifiedBy

A user which last updated an entity.

lastModifiedDate

LocalDateTime lastModifiedDate

A date on which an entity was last updated.

Class gov.niem.tools.api.db.base.BaseModelEntity

class BaseModelEntity extends BaseStewardEntity implements Serializable

Class gov.niem.tools.api.db.base.BaseNamespaceEntity

class BaseNamespaceEntity extends BaseVersionEntity<T extends BaseVersionEntity<T>> implements Serializable

Class gov.niem.tools.api.db.base.BaseStewardEntity

class BaseStewardEntity extends BaseEntity implements Serializable

Class gov.niem.tools.api.db.base.BaseVersionEntity

class BaseVersionEntity extends BaseModelEntity implements Serializable

Serialized Fields

isDeprecated

boolean isDeprecated

True if an entity is deprecated; false or null otherwise.

next

T extends BaseVersionEntity<T> next

Corresponding entity mapped from the next version.

original

T extends BaseVersionEntity<T> original

For a subset that reuses content from another model, this is the link to the original entity. The value is null if this entity is actually defined by its version rather than reused from another model as part of a subset.

Example 1: NIEM model 5.2 is the original source of property "nc:Person". In this case, this property is itself the original and has no other original source to point to. The value of original is null.

Example 2: Acme Crash Driver 1.0 reuses property nc:Person from NIEM model 5.2 and is not its original source. The value of original is a reference to the NIEM model 5.2 nc:Person property.

Although most information about an entity will be duplicated between the original and its usages via subsets, tracking the usages of each entity independently supports subset-approved customizations, like adjusted cardinality, custom namespace prefixes, property aliases, inlined substitutions, and flattened types.

prev

T extends BaseVersionEntity<T> prev

Corresponding entity mapped from the previous version.

Package gov.niem.tools.api.db.component

Class gov.niem.tools.api.db.component.Component

class Component extends BaseNamespaceEntity<T extends BaseNamespaceEntity<T>> implements Serializable

Serialized Fields

definition

String definition

A definition describing a property or type.

name

String name

A name of the property or type.

namespace

Namespace namespace

Namespace that defines this component.

prefix

String prefix

A namespace prefix for the property or type.

qname

String qname

Package gov.niem.tools.api.db.exceptions

Exception Class gov.niem.tools.api.db.exceptions.DatabaseKeyViolationException

class DatabaseKeyViolationException extends RuntimeException implements Serializable

Exception Class gov.niem.tools.api.db.exceptions.EntityNotFoundException

class EntityNotFoundException extends RuntimeException implements Serializable

Exception Class gov.niem.tools.api.db.exceptions.EntityNotUniqueException

class EntityNotUniqueException extends RuntimeException implements Serializable

Exception Class gov.niem.tools.api.db.exceptions.FieldNotFoundException

class FieldNotFoundException extends RuntimeException implements Serializable

Package gov.niem.tools.api.db.facet

Class gov.niem.tools.api.db.facet.Facet

class Facet extends BaseNamespaceEntity<Facet> implements Serializable

Serialized Fields

category

Facet.Category category

A kind of facet, e.g., "enumeration"

definition

String definition

prefix

String prefix

qname

String qname

type

Type type

Type that contains the facet.

value

String value

versionId

Long versionId

Package gov.niem.tools.api.db.model

Class gov.niem.tools.api.db.model.Model

class Model extends BaseStewardEntity implements Serializable

Serialized Fields

category

Model.Category category

A kind of data model.

description

String description

A description of a model.

developer

String developer

A name of an organization or person that developed a model.

fullName

String fullName

A full name used to identify a model.

keywords

String keywords

A common alias, term, or phrase that would help to facilitate search and discovery of this IEPD.

modelKey

String modelKey

A human-readable and url-friendly model identifier generated from the shortName field, unique within the set of models owned by its steward.

objective

Model.Objective objective

An intended use for a model, such as for actual implementation or for testing tool features or IEPD / message specification features.

purpose

String purpose

A description of the intended usage and reason for which an IEPD exists.

repo

String repo

A code repository which hosts full IEPDs or message specifications representing the model.

shortName

@NotBlank String shortName

A short name or acronym used to identify a model.

steward

Steward steward

A steward responsible for the management of the model.

subjects

String subjects

A description of the environment or NIEM Domain in which this IEPD is applicable or used.

versions

Set<Version> versions

A set of versions defined by a model.

website

String website

A website address by which a person or organization may be contacted.

Package gov.niem.tools.api.db.namespace

Class gov.niem.tools.api.db.namespace.Namespace

class Namespace extends BaseVersionEntity<Namespace> implements Serializable

Serialized Fields

category

Namespace.Category category

A kind of namespace.

definition

String definition

A definition that describes a namespace.

draft

String draft

A draft version of a namespace. NIEM conventions are to use the value "1" for a namespace that has reached release candidate status or has been published.

filename

String filename

The filename to use for representations of this namespace such as XML schemas, without a file extension.

filepath

String filepath

The filepath to use for nested representations of this namespace such as for XML schemas, without the filename or extension.

generation

Namespace.Generation generation

A means by which a namespace should be generated.

• build: Generate by assembling its properties and types
• static_file: Include it's pre-built file (e.g., externals and utilities)
• none: Namespace may be referenced but does not need to be included (e.g., XML Schema)

Defaults to "build".

name

String name

A name of a namespace.

prefix

String prefix

A short, non-normative identifier for a namespace.

properties

Set<Property> properties

target

Namespace.NdrTarget target

A code representing an NDR conformance target, or null if the namespace is not meant to be conformant.

types

Set<Type> types

uri

String uri

A normative identifier for a namespace.

version

Version version

Model version in which this entity is defined.

Package gov.niem.tools.api.db.property

Class gov.niem.tools.api.db.property.Property

class Property extends Component<Property> implements Serializable

Serialized Fields

alias

String alias

category

Property.Category category

A kind of property.

exampleContent

String exampleContent

group

Property group

A substitution group head, which may be replaced in message instances by this property.

keywords

String keywords

subproperties

Set<Subproperty> subproperties

substitutions

Set<Property> substitutions

type

Type type

A type that describes the structure and value set of the property.

usageInfo

String usageInfo

Package gov.niem.tools.api.db.steward

Class gov.niem.tools.api.db.steward.Steward

class Steward extends BaseEntity implements Serializable

Serialized Fields

address

String address

A complete address.

category

Steward.Category category

A kind of steward.

contactName

String contactName

A name of the person to be contacted.

country

CountryAlpha3CodeType country

A country, territory, dependency, or other such geopolitical subdivision of a location.

description

String description

A description of an organization.

email

@Email String email

An electronic mailing address by which a person or organization may be contacted.

fullName

String fullName

A name of an organization.

models

Set<Model> models

A set of models which belong to the steward.

phone

String phone

A complete telephone number.

shortName

@NotBlank(message="shortName is required") String shortName

A short name or acronym used to identify a steward. This could be the name of an organization or unit, a program name, or other kind of authoritative source.

stewardKey

String stewardKey

A human-readable and url-friendly steward identifier generated from the shortName field.

subunit

String subunit

A name of a subdivision of an organization.

unit

String unit

A name of a high-level division of an organization.

website

String website

A website address by which a person or organization may be contacted.

Package gov.niem.tools.api.db.subproperty

Class gov.niem.tools.api.db.subproperty.Subproperty

class Subproperty extends BaseNamespaceEntity<Subproperty> implements Serializable

Serialized Fields

definition

String definition

max

@Pattern(regexp="^unbounded|([1-9]\\d+)$") String max

Max cardinality 'unbounded' or 1-9 with zero or more additional digits.

min

@Pattern(regexp="^0|([1-9]\\d+)$") String min

Min cardinality 0 or 1-9 with zero or more additional digits.

property

Property property

propertyQname

String propertyQname

sequence

@jakarta.validation.constraints.Min(0L) int sequence

type

Type type

typeQname

String typeQname

versionId

Long versionId

Package gov.niem.tools.api.db.type

Class gov.niem.tools.api.db.type.Type

class Type extends Component<Type> implements Serializable

Serialized Fields

base

Type base

category

Type.Category category

dataProperties

Set<Property> dataProperties

derivation

Type.Derivation derivation

facets

Set<Facet> facets

pattern

Type.Pattern pattern

subproperties

Set<Subproperty> subproperties

Package gov.niem.tools.api.db.version

Class gov.niem.tools.api.db.version.Version

class Version extends BaseModelEntity implements Serializable

Serialized Fields

category

Version.Category category

A kind of version, such as major or minor.

conformanceTargets

String conformanceTargets

A list of one or more URIs that each represents an IEPD class to which the IEPD claims conformance.

draft

String draft

A draft of a version, such as "alpha1" or "rc2".

exchangePartners

String exchangePartners

A name of an entity or organization that uses this IEPD.

exchangePattern

String exchangePattern

A description of a transactional or design pattern used for this IEPD.

isCurrent

boolean isCurrent

True if this version of the model is considered the current version; false otherwise.

isPublished

boolean isPublished

True if a version has been published and the content is to be considered finalized; false otherwise.

messageRoots

Set<Property> messageRoots

A set of properties that serve as the root or starting point of message instances.

model

Model model

namespaces

Set<Namespace> namespaces

A set of namespaces defined by a version of a model.

next

Version next

Corresponding entity mapped from the next version.

niemVersion

Version niemVersion

A NIEM version on which this version is based, or itself if this is a NIEM version.

prev

Version prev

Corresponding entity mapped from the previous version.

revised

String revised

A date the latest changes to an IEPD were published (i.e., CreationDate of previous version).

status

String status

A description of the current state of this IEPD in development; may also project future plans for the IEPD.

uri

String uri

An URI identifier for a version of a model.

versionNumber

@NonNull String versionNumber

A number which identifies a version of a model, such as "5.2" or "1.0.1".