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

Class FacetService

java.lang.Object

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

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

gov.niem.tools.api.db.facet.FacetService

@Component
public class FacetService
extends BaseVersionEntityService<Facet>

Operations supporting facets.

Constructor Summary

Constructors

Constructor	Description
FacetService()

Method Summary

Modifier and Type	Method	Description
Facet	add(Type type, Facet.Category category, String value, String definition)	Creates a new facet with the given fields and adds it to the given type.
Facet	add(String stewardKey, String modelKey, String versionNumber, String qname, Facet.Category category, String value, String definition)	Creates a new facet with the given facet fields and adds it to the type matching the given type fields.
void	assertRequiredLocalFields(Facet facet)	Checks that the facet has all required fields.
void	assertUnique(Facet facet)	Checks that the database does not already have a facet with the same identifying fields.
long	countByNamespace(String stewardKey, String modelKey, String versionNumber, String prefix)	Count all facets by the namespace with the given fields.
long	countByProperty(String stewardKey, String modelKey, String versionNumber, String qname)	Count all facets by the type of the property with the given fields.
long	countByType(String stewardKey, String modelKey, String versionNumber, String qname)	Count all facets by the type with the given fields.
long	countByVersion(String stewardKey, String modelKey, String versionNumber)	Count all facets by the version with the given fields.
org.springframework.data.domain.Page<Facet>	findByNamespace(String stewardKey, String modelKey, String versionNumber, String prefix, org.springframework.data.domain.Pageable pageable)	Finds all facets in the database from the namespace matching the given fields.
org.springframework.data.domain.Page<Facet>	findByProperty(String stewardKey, String modelKey, String versionNumber, String qname, org.springframework.data.domain.Pageable pageable)	Finds all facets in the database from the type of the property matching the given fields.
org.springframework.data.domain.Page<Facet>	findByType(String stewardKey, String modelKey, String versionNumber, String qname, org.springframework.data.domain.Pageable pageable)	Finds all facets in the database from the type matching the given fields.
org.springframework.data.domain.Page<Facet>	findByVersion(String stewardKey, String modelKey, String versionNumber, org.springframework.data.domain.Pageable pageable)	Finds all facets in the database from the version matching the given fields.
Facet	findOne(Facet facet)	Finds a facet in the database matching the fields in the given facet object.
Facet	findOne(String stewardKey, String modelKey, String versionNumber, String qname, Facet.Category category, String value)	Finds a facet in the database with the given fields.
Optional<Facet>	findOneOptional(String stewardKey, String modelKey, String versionNumber, String qname, Facet.Category category, String value)	Optionally finds a facet in the database with the given fields.
FacetRepository	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

FacetService

public FacetService()

Method Details

repository

public FacetRepository repository()

Specified by:

repository in class BaseEntityService<Facet>

add

public Facet add(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname,
 Facet.Category category,
 String value,
 String definition)
          throws Exception

Creates a new facet with the given facet fields and adds it to the type matching the given type fields.

Throws:

Exception

add

public Facet add(Type type,
 Facet.Category category,
 String value,
 String definition)
          throws Exception

Creates a new facet with the given fields and adds it to the given type.

Throws:

Exception

findOneOptional

public Optional<Facet> findOneOptional(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname,
 Facet.Category category,
 String value)
                                throws EntityNotFoundException

Optionally finds a facet in the database with the given fields.

Throws:

EntityNotFoundException

findOne

public Facet findOne(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname,
 Facet.Category category,
 String value)
              throws EntityNotFoundException

Finds a facet in the database with the given fields.

Throws:

EntityNotFoundException

findOne

public Facet findOne(Facet facet)
              throws EntityNotFoundException

Finds a facet in the database matching the fields in the given facet object.

Specified by:

findOne in class BaseEntityService<Facet>

Throws:

EntityNotFoundException

findByVersion

public org.springframework.data.domain.Page<Facet> findByVersion(String stewardKey,
 String modelKey,
 String versionNumber,
 org.springframework.data.domain.Pageable pageable)
                                                          throws EntityNotFoundException

Finds all facets in the database from the version matching the given fields.

Throws:

EntityNotFoundException

findByNamespace

public org.springframework.data.domain.Page<Facet> findByNamespace(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix,
 org.springframework.data.domain.Pageable pageable)
                                                            throws EntityNotFoundException

Finds all facets in the database from the namespace matching the given fields.

Throws:

EntityNotFoundException

findByType

public org.springframework.data.domain.Page<Facet> findByType(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname,
 org.springframework.data.domain.Pageable pageable)
                                                       throws EntityNotFoundException

Finds all facets in the database from the type matching the given fields.

Throws:

EntityNotFoundException

findByProperty

public org.springframework.data.domain.Page<Facet> findByProperty(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname,
 org.springframework.data.domain.Pageable pageable)
                                                           throws EntityNotFoundException

Finds all facets in the database from the type of the property matching the given fields.

Throws:

EntityNotFoundException

countByVersion

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

Count all facets by the version with the given fields.

Throws:

EntityNotFoundException

countByNamespace

public long countByNamespace(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
                      throws EntityNotFoundException

Count all facets by the namespace with the given fields.

Throws:

EntityNotFoundException

countByType

public long countByType(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
                 throws EntityNotFoundException

Count all facets by the type with the given fields.

Throws:

EntityNotFoundException

countByProperty

public long countByProperty(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
                     throws EntityNotFoundException

Count all facets by the type of the property with the given fields.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(Facet facet)
                               throws FieldNotFoundException

Checks that the facet has all required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Facet>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Facet facet)
                  throws EntityNotUniqueException

Checks that the database does not already have a facet with the same identifying fields.

Specified by:

assertUnique in class BaseEntityService<Facet>

Throws:

EntityNotUniqueException