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

Class ComponentService<T extends Component<T>,U extends ComponentRepository<T>>

java.lang.Object

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

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

gov.niem.tools.api.db.component.ComponentService<T,U>

Direct Known Subclasses:

PropertyService, TypeService

public abstract class ComponentService<T extends Component<T>,U extends ComponentRepository<T>>
extends BaseVersionEntityService<T>

Operations for managing a component.

Field Summary

Fields

Modifier and Type	Field	Description
protected NamespaceService	namespaceService
protected U	repo
protected VersionService	versionService

Constructor Summary

Constructors

Constructor	Description
ComponentService()

Method Summary

Modifier and Type	Method	Description
T	add(Namespace namespace, String name, T component)	Add a component to the database.
T	add(Namespace namespace, T component)	Add a component to the database.
T	add(Version version, String prefix, String name, T component)	Add a component to the database.
T	add(Version version, T component)	Add a component to the database.
T	add(String stewardKey, String modelKey, String versionKey, T component)	Add a component to the database.
T	add(T component)	Add a component to the database.
void	assertRequiredLocalFields(T component)	Check that the given component has its required fields.
void	assertUnique(T component)	Check that the required fields in the given component do not already exist in the database.
long	countByNamespace(String stewardKey, String modelKey, String versionNumber, String prefix)	Count all components in a namespace with the given fields.
long	countByVersion(String stewardKey, String modelKey, String versionNumber)	Count all components in a version with the given fields.
List<T>	findByKeyword(String stewardKey, String modelKey, String versionKey, String keyword)	Find a list of the top components matching the keyword in the version with the given fields.
org.springframework.data.domain.Page<T>	findByNamespace(String stewardKey, String modelKey, String versionKey, String prefix, org.springframework.data.domain.Pageable pageable)	Find a page of all components in the namespace with the given fields.
org.springframework.data.domain.Page<T>	findByVersion(String stewardKey, String modelKey, String versionKey, org.springframework.data.domain.Pageable pageable)	Find a page of all components in the version with the given fields.
T	findOne(Version version, String qname)	Find a component in the database matching the given version and qualified name.
T	findOne(String stewardKey, String modelKey, String versionNumber, String qname)	Find a component in the database matching the given fields.
T	findOne(String stewardKey, String modelKey, String versionNumber, String prefix, String name)	Find a component in the database matching the given fields.
T	findOne(T component)	Find a component in the database matching identifying fields in the given component.
Optional<T>	findOneOptional(Version version, String qname)	Optionally find a component in the database matching the given fields.
Optional<T>	findOneOptional(String stewardKey, String modelKey, String versionNumber, String qname)	Optionally find a component in the database matching the given fields.
Optional<T>	findOneOptional(String stewardKey, String modelKey, String versionNumber, String prefix, String name)	Optionally find a component in the database matching the given fields.
static String	getQualifiedName(String qname)	Return the name from the given qualified name.
static String	getQualifiedPrefix(String qname)	Return the prefix from the given qualified name.
U	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

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

Field Details

repo

@Autowired
protected U extends ComponentRepository<T> repo

versionService

@Autowired
protected VersionService versionService

namespaceService

@Autowired
protected NamespaceService namespaceService

Constructor Details

ComponentService

public ComponentService()

Method Details

repository

public U repository()

Specified by:

repository in class BaseEntityService<T extends Component<T>>

add

public T add(String stewardKey,
 String modelKey,
 String versionKey,
 T component)
      throws Exception

Add a component to the database.

Throws:

Exception

add

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

Add a component to the database.

Throws:

Exception

add

public T add(Version version,
 T component)
      throws Exception

Add a component to the database.

Throws:

Exception

add

public T add(Namespace namespace,
 String name,
 T component)
      throws Exception

Add a component to the database.

Throws:

Exception

add

public T add(Namespace namespace,
 T component)
      throws Exception

Add a component to the database.

Throws:

Exception

add

public T add(T component)
      throws Exception

Add a component to the database.

Overrides:

add in class BaseEntityService<T extends Component<T>>

Throws:

Exception

findOne

public T findOne(T component)
          throws EntityNotFoundException

Find a component in the database matching identifying fields in the given component.

Specified by:

findOne in class BaseEntityService<T extends Component<T>>

Throws:

EntityNotFoundException

findOne

public T findOne(Version version,
 String qname)
          throws EntityNotFoundException

Find a component in the database matching the given version and qualified name.

Throws:

EntityNotFoundException

findOne

public T findOne(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
          throws EntityNotFoundException

Find a component in the database matching the given fields.

Throws:

EntityNotFoundException

findOne

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

Find a component in the database matching the given fields.

Throws:

EntityNotFoundException

findOneOptional

public Optional<T> findOneOptional(Version version,
 String qname)
                            throws EntityNotFoundException

Optionally find a component in the database matching the given fields.

Throws:

EntityNotFoundException

findOneOptional

public Optional<T> findOneOptional(String stewardKey,
 String modelKey,
 String versionNumber,
 String qname)
                            throws EntityNotFoundException

Optionally find a component in the database matching the given fields.

Throws:

EntityNotFoundException

findOneOptional

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

Optionally find a component in the database matching the given fields.

Throws:

EntityNotFoundException

findByVersion

public org.springframework.data.domain.Page<T> findByVersion(String stewardKey,
 String modelKey,
 String versionKey,
 org.springframework.data.domain.Pageable pageable)
                                                      throws Exception

Find a page of all components in the version with the given fields.

Throws:

Exception

findByNamespace

public org.springframework.data.domain.Page<T> findByNamespace(String stewardKey,
 String modelKey,
 String versionKey,
 String prefix,
 org.springframework.data.domain.Pageable pageable)
                                                        throws Exception

Find a page of all components in the namespace with the given fields.

Throws:

Exception

findByKeyword

public List<T> findByKeyword(String stewardKey,
 String modelKey,
 String versionKey,
 String keyword)
                      throws Exception

Find a list of the top components matching the keyword in the version with the given fields.

Note that the keyword may be qualified with a namespace prefix.

Additional, a qualified keyword or a keyword with a leading ':' (but no prefix) will be treated as name-starts-wth vs leading and trailing wildcards.

Throws:

Exception

countByVersion

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

Count all components in a version with the given fields.

Throws:

EntityNotFoundException

countByNamespace

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

Count all components in a namespace with the given fields.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(T component)
                               throws FieldNotFoundException

Check that the given component has its required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<T extends Component<T>>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(T component)
                  throws EntityNotUniqueException

Check that the required fields in the given component do not already exist in the database.

Specified by:

assertUnique in class BaseEntityService<T extends Component<T>>

Throws:

EntityNotUniqueException

getQualifiedPrefix

public static String getQualifiedPrefix(String qname)

Return the prefix from the given qualified name.

getQualifiedName

public static String getQualifiedName(String qname)

Return the name from the given qualified name.