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

Class ModelService

java.lang.Object

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

gov.niem.tools.api.db.model.ModelService

@Service
public class ModelService
extends BaseEntityService<Model>

Operations supporting a model.

Constructor Summary

Constructors

Constructor	Description
ModelService()

Method Summary

Modifier and Type	Method	Description
Model	add(Model model)	Creates a new model in the database with the fields in the given model object and adds it to the steward with the steward key in the given model object.
Model	add(Steward steward, String shortName, String longName, Model.Category category, String description)	Creates a new model in the database with the given fields and adds it to the given steward.
Model	add(String stewardKey, Model model)	Creates a new model in the database with the fields in the given model object and adds it to the steward with the given steward key.
Model	add(String stewardKey, String shortName, String longName, Model.Category category)	Creates a new model in the database with the given fields and adds it to the steward with the given key.
Model	add(String stewardKey, String shortName, String longName, Model.Category category, String description)	Creates a new model in the database with the given fields and adds it to the steward with the given key.
void	assertRequiredLocalFields(Model model)	Checks that the object has the required fields.
void	assertUnique(Model model)	Checks that the object will be unique and will not clash with another object in the database.
Version	currentNiemVersion()	Gets the version from the NIEM reference model labeled as current.
void	delete(String stewardKey, String modelKey)	Deletes a model in the database with the given steward and model keys.
Model	edit(Steward steward, String modelKey, Model updatedModel)	Edits a model in the database with the given steward and model key with the fields in the given model object.
Model	edit(String stewardKey, String modelKey, Model updatedModel)	Edits a model in the database with the given steward and model keys with the fields in the given model object.
List<Model>	findAll()	Gets a list of all models in the database.
Model	findOne(Model model)	Finds a model in the database with the steward and model keys in the given model object.
Model	findOne(String stewardKey, String modelKey)	Finds a model in the database with the given steward and model keys.
Model	findOneByShortName(String stewardKey, String shortName)	Finds a model in the database with the given steward key and model short name.
Optional<Model>	findOneByShortNameOptional(String stewardKey, String shortName)	Optionally finds a model in the database with the given steward key and model short name.
Model	findOneNiem()	Finds the NIEM reference model.
Optional<Model>	findOneOptional(String stewardKey, String modelKey)	Optionally finds a model in the database with the given steward and model keys.
ModelRepository	repository()

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

assertFieldNotNullAndNotEmpty, 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

ModelService

public ModelService()

Method Details

repository

public ModelRepository repository()

Specified by:

repository in class BaseEntityService<Model>

add

public Model add(String stewardKey,
 String shortName,
 String longName,
 Model.Category category)
          throws Exception

Creates a new model in the database with the given fields and adds it to the steward with the given key.

Throws:

Exception

add

public Model add(String stewardKey,
 String shortName,
 String longName,
 Model.Category category,
 String description)
          throws Exception

Creates a new model in the database with the given fields and adds it to the steward with the given key.

Throws:

Exception

add

public Model add(Steward steward,
 String shortName,
 String longName,
 Model.Category category,
 String description)
          throws Exception

Creates a new model in the database with the given fields and adds it to the given steward.

Throws:

Exception

add

public Model add(Model model)
          throws Exception

Creates a new model in the database with the fields in the given model object and adds it to the steward with the steward key in the given model object.

Overrides:

add in class BaseEntityService<Model>

Throws:

Exception

add

public Model add(String stewardKey,
 Model model)
          throws Exception

Creates a new model in the database with the fields in the given model object and adds it to the steward with the given steward key.

Throws:

Exception

edit

public Model edit(String stewardKey,
 String modelKey,
 Model updatedModel)
           throws Exception

Edits a model in the database with the given steward and model keys with the fields in the given model object.

Throws:

Exception

edit

public Model edit(Steward steward,
 String modelKey,
 Model updatedModel)
           throws Exception

Edits a model in the database with the given steward and model key with the fields in the given model object.

Throws:

Exception

delete

public void delete(String stewardKey,
 String modelKey)
            throws Exception

Deletes a model in the database with the given steward and model keys.

Throws:

Exception

findOne

public Model findOne(Model model)
              throws EntityNotFoundException

Finds a model in the database with the steward and model keys in the given model object.

Specified by:

findOne in class BaseEntityService<Model>

Throws:

EntityNotFoundException

findOne

public Model findOne(String stewardKey,
 String modelKey)
              throws EntityNotFoundException

Finds a model in the database with the given steward and model keys.

Throws:

EntityNotFoundException

findOneOptional

public Optional<Model> findOneOptional(String stewardKey,
 String modelKey)
                                throws EntityNotFoundException

Optionally finds a model in the database with the given steward and model keys.

Throws:

EntityNotFoundException

findOneByShortNameOptional

public Optional<Model> findOneByShortNameOptional(String stewardKey,
 String shortName)

Optionally finds a model in the database with the given steward key and model short name.

findOneByShortName

public Model findOneByShortName(String stewardKey,
 String shortName)
                         throws Exception

Finds a model in the database with the given steward key and model short name.

Throws:

Exception

findOneNiem

public Model findOneNiem()
                  throws EntityNotFoundException

Finds the NIEM reference model.

Throws:

EntityNotFoundException

currentNiemVersion

public Version currentNiemVersion()

Gets the version from the NIEM reference model labeled as current.

findAll

public List<Model> findAll()

Gets a list of all models in the database.

assertRequiredLocalFields

public void assertRequiredLocalFields(Model model)
                               throws FieldNotFoundException

Description copied from class: BaseEntityService

Checks that the object has the required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Model>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Model model)
                  throws EntityNotUniqueException

Description copied from class: BaseEntityService

Checks that the object will be unique and will not clash with another object in the database.

Specified by:

assertUnique in class BaseEntityService<Model>

Throws:

EntityNotUniqueException