com.tomtom.speedtools.mongodb.checkdb

Class CheckDBBase.CollectionChecker

java.lang.Object

com.tomtom.speedtools.mongodb.checkdb.CheckDBBase.CollectionChecker

Enclosing class:

CheckDBBase

public class CheckDBBase.CollectionChecker
extends Object

Helper class to check a collection.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<EntityMapper.Field>	allFields The set allFields will grow to contain all fields, based on mappers, which are removed one by one by the 'field' method.
protected com.mongodb.DBCollection	collection
protected String	collectionName
protected int	count
protected com.mongodb.DBCursor	cursor
protected boolean	isEmpty
protected EntityMapper	mapper
protected long	nrRecordsInCollection
protected List<CheckDBBase.UniquenessChecker<?>>	uniquenessCheckers

Constructor Summary

Constructors

Constructor and Description
CollectionChecker(String collectionName, EntityMapper<?> mapper)

Method Summary

Modifier and Type	Method and Description
protected <T> CheckDBBase.UniquenessChecker<T>	createUniquenessChecker(boolean logAsErrors, EntityMapper.Field<?>... fieldPath) Creates a new CheckDBBase.UniquenessChecker for this collection.
void	done()
void	error(Uid<?> recordId, String message, String fieldPath, Exception exception)
boolean	hasNext()
<T> Tuple<Uid<?>,T>	next()
<T> Tuple<Uid<?>,T>	next(boolean recordIdIsUUID)
void	warning(Uid<?> recordId, String message, String fieldPath)

Methods inherited from class java.lang.Object

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

Field Detail

collection

@Nonnull
protected final com.mongodb.DBCollection collection

cursor

@Nullable
protected final com.mongodb.DBCursor cursor

mapper

@Nonnull
protected final EntityMapper mapper

allFields

@Nonnull
protected final Set<EntityMapper.Field> allFields

The set allFields will grow to contain all fields, based on mappers, which are removed one by one by the 'field' method. When record checking is done, the set is checked for non-checked fields. This field is directly referenced in threads, so must be thread safe.

nrRecordsInCollection

protected long nrRecordsInCollection

count

protected int count

isEmpty

protected final boolean isEmpty

collectionName

protected final String collectionName

uniquenessCheckers

protected final List<CheckDBBase.UniquenessChecker<?>> uniquenessCheckers

Constructor Detail

CollectionChecker

public CollectionChecker(@Nonnull
                         String collectionName,
                         @Nonnull
                         EntityMapper<?> mapper)

Method Detail

hasNext

public boolean hasNext()

next

@Nullable
public <T> Tuple<Uid<?>,T> next()

next

@Nullable
public <T> Tuple<Uid<?>,T> next(boolean recordIdIsUUID)

done

public void done()

error

public void error(@Nonnull
                  Uid<?> recordId,
                  @Nonnull
                  String message,
                  @Nullable
                  String fieldPath,
                  @Nullable
                  Exception exception)

warning

public void warning(@Nonnull
                    Uid<?> recordId,
                    @Nonnull
                    String message,
                    @Nullable
                    String fieldPath)

createUniquenessChecker

@Nonnull
protected <T> CheckDBBase.UniquenessChecker<T> createUniquenessChecker(boolean logAsErrors,
                                                                                @Nonnull
                                                                                EntityMapper.Field<?>... fieldPath)

Creates a new CheckDBBase.UniquenessChecker for this collection. The returned UniquenessChecker must only be used for data contained within this collection, otherwise uniqueness violations will be reported on the wrong collection. Values to check for uniqueness can then be added to it using add(Uid, Object) or add(Uid, Collection). The actual check will be performed once all other checks in this CollectionChecker have been finished, to ensure that all values to check for uniqueness have been added to the UniquenessChecker.

Type Parameters:

T - The type of the values to check for uniqueness

Parameters:

logAsErrors - True if violations are logged as errors, false if logged as warnings.

fieldPath - The field path within the collection that needs to be unique over all the elements of the collection.

Returns:

Returns a new UniquenessChecker.