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

Class NamespaceService

java.lang.Object

gov.niem.tools.api.db.base.BaseEntityService<Namespace>

gov.niem.tools.api.db.base.BaseVersionEntityService<Namespace>

gov.niem.tools.api.db.namespace.NamespaceService

@Service
public class NamespaceService
extends BaseVersionEntityService<Namespace>

Operations to support namespaces.

Constructor Summary

Constructors

Constructor	Description
NamespaceService()

Method Summary

Modifier and Type	Method	Description
Namespace	add(Version version, Namespace namespace)	Creates a new namespace in the database with the given namespace object and adds it to the given version object.
Namespace	add(Version version, String prefix, String name)	Creates a new namespace in the database with the given fields and adds it to the given version.
Namespace	add(String stewardKey, String modelKey, String versionNumber, Namespace namespace)	Creates a new namespace in the database with the given namespace object and adds it to the version with the given version fields.
Namespace	add(String stewardKey, String modelKey, String versionNumber, String prefix)	Creates a new namespace in the database with the given namespace fields and adds it to the version with the given version fields.
Namespace	add(String stewardKey, String modelKey, String versionNumber, String prefix, String name)	Creates a new namespace in the database with the given namespace fields and adds it to the version with the given version fields.
void	assertRequiredLocalFields(Namespace namespace)	Checks that all required fields are present.
void	assertUnique(Namespace namespace)	Checks that the database does not already contain a namespace with the same identifying fields as the given namespace object.
long	count(String stewardKey, String modelKey, String versionNumber)	Count the number of namespaces with the given fields.
long	count(String stewardKey, String modelKey, String versionNumber, Namespace.Category category)	Count the number of namespaces with the given fields.
List<Namespace>	findAll()	Finds all namespaces in the database.
List<Namespace>	findByVersion(String stewardKey, String modelKey, String versionNumber)	Finds all namespaces in the database in the version with the given fields.
Namespace	findOne(Namespace namespace)	Finds a namespace in the database matching identifiers in the given namespace object.
Namespace	findOne(Version version, String prefix)	Finds a namespace in the database with the given prefix in the version matching the given version object.
Namespace	findOne(String stewardKey, String modelKey, String versionNumber, String prefix)	Finds a namespace in the database with the given prefix in the version with the given version fields.
Optional<Namespace>	findOneOptional(Version version, String prefix)	Optionally finds a namespace in the database with the given prefix in the given version.
Optional<Namespace>	findOneOptional(String stewardKey, String modelKey, String versionNumber, String prefix)	Optionally finds a namespace in the database with the given prefix in the version with the given version fields.
NamespaceRepository	repository()

Methods inherited from class gov.niem.tools.api.db.base.BaseVersionEntityService

getHistory, getNext, getPrev

Methods inherited from class gov.niem.tools.api.db.base.BaseEntityService

add, assertFieldNotNullAndNotEmpty, count, delete, edit, findOneOptional, getEntityClassName, getNotFoundException, loadId, merge, saveExisting, saveNew, throwNotFound, throwNotFound, throwNotFound, throwNotUnique, throwNotUnique, throwNotUnique

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NamespaceService

public NamespaceService()

Method Details

repository

public NamespaceRepository repository()

Specified by:

repository in class BaseEntityService<Namespace>

add

public Namespace add(Version version,
 String prefix,
 String name)
              throws Exception

Creates a new namespace in the database with the given fields and adds it to the given version.

Throws:

Exception

add

public Namespace add(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix,
 String name)
              throws Exception

Creates a new namespace in the database with the given namespace fields and adds it to the version with the given version fields.

Throws:

Exception

add

public Namespace add(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
              throws Exception

Creates a new namespace in the database with the given namespace fields and adds it to the version with the given version fields.

Throws:

Exception

add

public Namespace add(String stewardKey,
 String modelKey,
 String versionNumber,
 Namespace namespace)
              throws Exception

Creates a new namespace in the database with the given namespace object and adds it to the version with the given version fields.

Throws:

Exception

add

public Namespace add(Version version,
 Namespace namespace)
              throws Exception

Creates a new namespace in the database with the given namespace object and adds it to the given version object.

Throws:

Exception

findAll

public List<Namespace> findAll()

Finds all namespaces in the database.

findByVersion

public List<Namespace> findByVersion(String stewardKey,
 String modelKey,
 String versionNumber)
                              throws EntityNotFoundException

Finds all namespaces in the database in the version with the given fields.

Throws:

EntityNotFoundException

findOneOptional

public Optional<Namespace> findOneOptional(Version version,
 String prefix)
                                    throws EntityNotFoundException

Optionally finds a namespace in the database with the given prefix in the given version.

Throws:

EntityNotFoundException

findOneOptional

public Optional<Namespace> findOneOptional(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
                                    throws EntityNotFoundException

Optionally finds a namespace in the database with the given prefix in the version with the given version fields.

Throws:

EntityNotFoundException

findOne

public Namespace findOne(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
                  throws EntityNotFoundException

Finds a namespace in the database with the given prefix in the version with the given version fields.

Throws:

EntityNotFoundException

findOne

public Namespace findOne(Version version,
 String prefix)
                  throws EntityNotFoundException

Finds a namespace in the database with the given prefix in the version matching the given version object.

Throws:

EntityNotFoundException

findOne

public Namespace findOne(Namespace namespace)
                  throws EntityNotFoundException

Finds a namespace in the database matching identifiers in the given namespace object.

Specified by:

findOne in class BaseEntityService<Namespace>

Throws:

EntityNotFoundException

count

public long count(String stewardKey,
 String modelKey,
 String versionNumber)
           throws EntityNotFoundException

Count the number of namespaces with the given fields.

Throws:

EntityNotFoundException

count

public long count(String stewardKey,
 String modelKey,
 String versionNumber,
 Namespace.Category category)
           throws EntityNotFoundException

Count the number of namespaces with the given fields.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(Namespace namespace)
                               throws FieldNotFoundException

Checks that all required fields are present.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Namespace>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Namespace namespace)
                  throws EntityNotUniqueException

Checks that the database does not already contain a namespace with the same identifying fields as the given namespace object.

Specified by:

assertUnique in class BaseEntityService<Namespace>

Throws:

EntityNotUniqueException