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

Class SubpropertyService

java.lang.Object

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

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

gov.niem.tools.api.db.subproperty.SubpropertyService

@Component
public class SubpropertyService
extends BaseVersionEntityService<Subproperty>

Operations for subproperties.

Todo:

Return Subproperty lists instead of sets

Constructor Summary

Constructors

Constructor	Description
SubpropertyService()

Method Summary

Modifier and Type	Method	Description
Subproperty	add(Type type, Property property, String min, String max)	Creates a new subproperty in the database and adds it to the type with the given type.
Subproperty	add(Version version, String typeQname, String propertyQname, String min, String max)	Creates a new subproperty in the database and adds it to the type with the given type fields.
Subproperty	add(String stewardKey, String modelKey, String versionNumber, String typeQname, String propertyQname, String min, String max)	Creates a new subproperty in the database and adds it to the type with the given type fields.
void	addToCmfModel(Subproperty subproperty, org.mitre.niem.cmf.Model cmfModel, Boolean addDependencies, AddModelReason addModelReason, Test test)	Adds the given subproperty to the given CMF model as either a CMF property association or a CMF augmentation record.
void	assertRequiredLocalFields(Subproperty subproperty)	Checks that the object has the required fields.
void	assertUnique(Subproperty subproperty)	Checks that the database does not contain a subproperty with the same identifying fields in the given subproperty object.
long	countByNamespace(String stewardKey, String modelKey, String versionNumber, String prefix)	Count subproperties in the namespace matching the given fields.
long	countByProperty(String stewardKey, String modelKey, String versionNumber, String qname)	Count subproperties occurrence for the property matching the given fields.
long	countByType(String stewardKey, String modelKey, String versionNumber, String qname)	Count subproperties for the type matching the given fields.
long	countByVersion(String stewardKey, String modelKey, String versionNumber)	Count subproperties in the version matching the given fields.
Subproperty	findAugmentationPoint(Type type)	Find the augmentation point subproperty for the type with the given fields.
Set<Subproperty>	findByProperty(Property property)	Finds all subproperties in the database with the given property.
Set<Subproperty>	findByProperty(String stewardKey, String modelKey, String versionNumber, String qname)	Finds all subproperties in the database in the version with the given version fields and with the property with the given qualified property name.
Set<Subproperty>	findByPropertyPrefix(String stewardKey, String modelKey, String versionNumber, String prefix)	Finds all subproperties in the database in the version with the given version fields and with properties with the given namespace prefix.
Set<Subproperty>	findByType(Type type)	Finds the subproperties from the database in the given type.
Set<Subproperty>	findByType(String stewardKey, String modelKey, String versionNumber, String qname)	Finds the subproperties from the database in the type with the given fields.
Set<Subproperty>	findByTypePrefix(String stewardKey, String modelKey, String versionNumber, String prefix)	Finds all subproperties in the database in the version with the given version fields and with types with the given namespace prefix.
Set<Subproperty>	findByVersion(String stewardKey, String modelKey, String versionNumber)	Finds all subproperties in the database in the version with the given fields.
Subproperty	findOne(Subproperty subproperty)	Finds a subproperty in the database with the identifying fields from the given subproperty object.
Subproperty	findOne(Type type, Property property)	Finds a subproperty in the database with the given type and property.
Subproperty	findOne(Version version, String typeQname, String propertyQname)	Finds a subproperty in the database with the type with the given version and qualified type name and the property with the given qualified property name.
Subproperty	findOne(String stewardKey, String modelKey, String versionNumber, String typeQname, String propertyQname)	Finds a subproperty in the database with the type with the given type fields and the property with the given qualified property name.
Optional<Subproperty>	findOneOptional(Version version, String typeQname, String propertyQname)	Optionally finds a subproperty in the database with a type with the given version and qualified type name and a property with the given qualified property name.
SubpropertyRepository	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

SubpropertyService

public SubpropertyService()

Method Details

repository

public SubpropertyRepository repository()

Specified by:

repository in class BaseEntityService<Subproperty>

add

public Subproperty add(String stewardKey,
 String modelKey,
 String versionNumber,
 String typeQname,
 String propertyQname,
 String min,
 String max)
                throws Exception

Creates a new subproperty in the database and adds it to the type with the given type fields.

Throws:

Exception

add

public Subproperty add(Version version,
 String typeQname,
 String propertyQname,
 String min,
 String max)
                throws Exception

Creates a new subproperty in the database and adds it to the type with the given type fields.

Throws:

Exception

add

public Subproperty add(Type type,
 Property property,
 String min,
 String max)
                throws Exception

Creates a new subproperty in the database and adds it to the type with the given type.

Throws:

Exception

findOne

public Subproperty findOne(Subproperty subproperty)
                    throws EntityNotFoundException

Finds a subproperty in the database with the identifying fields from the given subproperty object.

Specified by:

findOne in class BaseEntityService<Subproperty>

Throws:

EntityNotFoundException

findOne

public Subproperty findOne(String stewardKey,
 String modelKey,
 String versionNumber,
 String typeQname,
 String propertyQname)
                    throws EntityNotFoundException

Finds a subproperty in the database with the type with the given type fields and the property with the given qualified property name.

Throws:

EntityNotFoundException

findOne

public Subproperty findOne(Version version,
 String typeQname,
 String propertyQname)
                    throws EntityNotFoundException

Finds a subproperty in the database with the type with the given version and qualified type name and the property with the given qualified property name.

Throws:

EntityNotFoundException

findOne

public Subproperty findOne(Type type,
 Property property)
                    throws EntityNotFoundException

Finds a subproperty in the database with the given type and property.

Throws:

EntityNotFoundException

findOneOptional

public Optional<Subproperty> findOneOptional(Version version,
 String typeQname,
 String propertyQname)

Optionally finds a subproperty in the database with a type with the given version and qualified type name and a property with the given qualified property name.

findByType

public Set<Subproperty> findByType(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
                            throws Exception

Finds the subproperties from the database in the type with the given fields.

Throws:

Exception

findByType

public Set<Subproperty> findByType(Type type)
                            throws Exception

Finds the subproperties from the database in the given type.

Throws:

Exception

findByProperty

public Set<Subproperty> findByProperty(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
                                throws Exception

Finds all subproperties in the database in the version with the given version fields and with the property with the given qualified property name.

Throws:

Exception

findByProperty

public Set<Subproperty> findByProperty(Property property)
                                throws Exception

Finds all subproperties in the database with the given property.

Throws:

Exception

findByVersion

public Set<Subproperty> findByVersion(String stewardKey,
 String modelKey,
 String versionNumber)
                               throws Exception

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

Throws:

Exception

findByTypePrefix

public Set<Subproperty> findByTypePrefix(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
                                  throws Exception

Finds all subproperties in the database in the version with the given version fields and with types with the given namespace prefix.

Throws:

Exception

findByPropertyPrefix

public Set<Subproperty> findByPropertyPrefix(String stewardKey,
 String modelKey,
 String versionNumber,
 String prefix)
                                      throws Exception

Finds all subproperties in the database in the version with the given version fields and with properties with the given namespace prefix.

Throws:

Exception

findAugmentationPoint

public Subproperty findAugmentationPoint(Type type)
                                  throws EntityNotFoundException

Find the augmentation point subproperty for the type with the given fields.

Throws:

EntityNotFoundException

countByVersion

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

Count subproperties in the version matching the given fields.

Throws:

EntityNotFoundException

countByNamespace

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

Count subproperties in the namespace matching the given fields.

Throws:

EntityNotFoundException

countByType

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

Count subproperties for the type matching the given fields.

Throws:

EntityNotFoundException

countByProperty

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

Count subproperties occurrence for the property matching the given fields.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(Subproperty subproperty)
                               throws FieldNotFoundException

Description copied from class: BaseEntityService

Checks that the object has the required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Subproperty>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Subproperty subproperty)
                  throws EntityNotUniqueException

Checks that the database does not contain a subproperty with the same identifying fields in the given subproperty object.

Specified by:

assertUnique in class BaseEntityService<Subproperty>

Throws:

EntityNotUniqueException

addToCmfModel

public void addToCmfModel(Subproperty subproperty,
 org.mitre.niem.cmf.Model cmfModel,
 Boolean addDependencies,
 AddModelReason addModelReason,
 Test test)
                   throws Exception

Adds the given subproperty to the given CMF model as either a CMF property association or a CMF augmentation record.

Throws:

Exception