com.screenscraper.datamanager.sql

Class SqlDuplicateFilter

java.lang.Object

com.screenscraper.datamanager.sql.SqlDuplicateFilter

public class SqlDuplicateFilter
extends java.lang.Object

A DataFilter designed to filter out duplicate records in a database on insertion

Method Summary

Modifier and Type	Method and Description
void	addConstraint(java.util.Set<java.lang.String> columns)
void	addConstraint(java.lang.String column)
void	addConstraint(java.lang.String table, java.lang.String column) create a match definition
java.lang.String	getFilterName()
boolean	isRunLookupIfFieldHasNull() Returns the RunLookupIfFieldHasNull for the object
static SqlDuplicateFilter	register(java.lang.String table, SqlDataManager dm) Registers a new duplicate filter with a callback priority of Integer.MIN_VALUE for the lookup handler
static SqlDuplicateFilter	register(java.lang.String table, SqlDataManager dm, int onWritePriority) Registers a new duplicate filter with a specified callback priority for the lookup (so an order to run them can be established)
boolean	run(DataNode node) apply the filter to the data nodes.
(package private) void	runFilter(DataNode node, java.util.List<java.lang.String> pks, java.sql.Connection con)
void	setFilterName(java.lang.String filterName) Sets the name for this filter.
void	setRunLookupIfFieldHasNull(boolean runLookupIfFieldHasNull) Sets the RunLookupIfFieldHasNull for the object

Methods inherited from class java.lang.Object

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

Method Detail

register

@NotNull
public static SqlDuplicateFilter register(@NotNull
                                                    java.lang.String table,
                                                    @NotNull
                                                    SqlDataManager dm)

Registers a new duplicate filter with a callback priority of Integer.MIN_VALUE for the lookup handler

Parameters:

table - The table with which to register the duplicate filter

dm - The data manager

Returns:

The registered filter

register

@NotNull
public static SqlDuplicateFilter register(@NotNull
                                                    java.lang.String table,
                                                    @NotNull
                                                    SqlDataManager dm,
                                                    int onWritePriority)

Registers a new duplicate filter with a specified callback priority for the lookup (so an order to run them can be established)

Parameters:

table - The table with which to register the duplicate filter

dm - The data manager

onWritePriority - The priority (lower is higher priority) for the registered callback (done at the DataManagerEventSource.EventFireTime#onWrite time)

Returns:

The registered filter

Since:

7.0.11a

isRunLookupIfFieldHasNull

@InternalOnly
public boolean isRunLookupIfFieldHasNull()

Returns the RunLookupIfFieldHasNull for the object

Returns:

The RunLookupIfFieldHasNull for the object

setRunLookupIfFieldHasNull

public void setRunLookupIfFieldHasNull(boolean runLookupIfFieldHasNull)

Sets the RunLookupIfFieldHasNull for the object

Parameters:

runLookupIfFieldHasNull - The new value for RunLookupIfFieldHasNull

setFilterName

public void setFilterName(@NotNull
                          java.lang.String filterName)

Sets the name for this filter. The only use is for logging. This should be set before the filter is going to be used (the method isn't thread safe)

Parameters:

filterName - The name to use for this filter (for debugging purposes)

getFilterName

@InternalOnly
public java.lang.String getFilterName()

addConstraint

public void addConstraint(@NotNull
                          java.lang.String column)

Parameters:

column - must be formatted as "table.column", for example if the table name is "products" and the column is price it would be "products.price"

addConstraint

public void addConstraint(@NotNull
                          java.util.Set<java.lang.String> columns)

Parameters:

columns - each String must be formatted as "table.column", for example if the table name is "products" and the column is price it would be "products.price"

addConstraint

public void addConstraint(@Nullable
                          java.lang.String table,
                          @Nullable
                          java.lang.String column)

create a match definition

Parameters:

table - The table for which to add a constraint

column - The name of the column to which the constraint applies

run

@InternalOnly
public boolean run(@NotNull
                                  DataNode node)

apply the filter to the data nodes. This will query the database and fill in values for the primary keys on matching nodes

Parameters:

node - The node to apply the filter on

Returns:

true if the write was successful

runFilter

void runFilter(@NotNull
               DataNode node,
               @NotNull
               java.util.List<java.lang.String> pks,
               @NotNull
               java.sql.Connection con)
        throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException