com.belladati.sdk.dataset.data

Class OverwritePolicy

java.lang.Object

com.belladati.sdk.dataset.data.OverwritePolicy

public abstract class OverwritePolicy
extends Object

Indicates what to do with existing data during the import. Options include doing nothing, deleting or overwriting selected records, and clearing all data.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
static OverwritePolicy	byAllAttributes() Returns an OverwritePolicy that deletes records that are identical in all attributes with a record being imported.
static OverwritePolicy	byAttributes(List<String> attributes) Returns an OverwritePolicy that deletes records that are identical in the specified attributes with a record being imported.
static OverwritePolicy	byAttributes(String firstAttribute, String... otherAttributes) Returns an OverwritePolicy that deletes records that are identical in the specified attributes with a record being imported.
static OverwritePolicy	byDateFrom(String attribute, Calendar start) Returns an OverwritePolicy that deletes records with a date on or after the given date in the specified column.
static OverwritePolicy	byDateFromTo(String attribute, Calendar start, Calendar end) Returns an OverwritePolicy that deletes records with a date between or on the given dates in the specified column.
static OverwritePolicy	byDateTo(String attribute, Calendar end) Returns an OverwritePolicy that deletes records with a date before or on the given date in the specified column.
static OverwritePolicy	deleteAll() Returns an OverwritePolicy that deletes all data in the data set before importing.
static OverwritePolicy	deleteNone() Returns an OverwritePolicy that makes no changes to the existing data.
List<String>	getAttributeCodes() Returns all attribute codes used in this policy.
abstract com.fasterxml.jackson.databind.JsonNode	toJson() Builds this policy's JSON representation.

Methods inherited from class java.lang.Object

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

Method Detail

deleteAll

public static OverwritePolicy deleteAll()

Returns an OverwritePolicy that deletes all data in the data set before importing. Only the newly imported records will be present in the data set.

Returns:

a policy deleting all data

deleteNone

public static OverwritePolicy deleteNone()

Returns an OverwritePolicy that makes no changes to the existing data. All previous records are kept and newly imported records appended to the data set.

Returns:

a policy keeping all data

byAllAttributes

public static OverwritePolicy byAllAttributes()

Returns an OverwritePolicy that deletes records that are identical in all attributes with a record being imported. As a result, no two records can exist in the data set that have the entirely same attribute values.

Empty attribute values in existing data are treated as matching anything. Existing records that match an imported record on all non-empty attributes are deleted.

Returns:

a policy deleting non-unique data by all attributes

byAttributes

public static OverwritePolicy byAttributes(String firstAttribute,
                           String... otherAttributes)

Returns an OverwritePolicy that deletes records that are identical in the specified attributes with a record being imported. As a result, no two records can exist in the data set that have the same values for all of those attributes at once.
At least one attribute needs to be specified.

Empty attribute values in existing data are treated as matching anything. Existing records that match an imported record on all non-empty attributes are deleted.

Parameters:

firstAttribute - first attribute

otherAttributes - additional, optional attributes

Returns:

a policy deleting non-unique data by selected attributes

byAttributes

public static OverwritePolicy byAttributes(List<String> attributes)
                                    throws NoColumnsException

Returns an OverwritePolicy that deletes records that are identical in the specified attributes with a record being imported. As a result, no two records can exist in the data set that have the same values for all of those attributes at once.
At least one attribute needs to be specified.

Empty attribute values in existing data are treated as matching anything. Existing records that match an imported record on all non-empty attributes are deleted.

Parameters:

attributes - attributes to match

Returns:

a policy deleting non-unique data by selected attributes

Throws:

NoColumnsException - if the list is empty

byDateFrom

public static OverwritePolicy byDateFrom(String attribute,
                         Calendar start)

Returns an OverwritePolicy that deletes records with a date on or after the given date in the specified column.

Records with an empty date value in existing data are also deleted.

Parameters:

attribute - date attribute to compare

start - first day (inclusive) from which to delete data

byDateTo

public static OverwritePolicy byDateTo(String attribute,
                       Calendar end)

Returns an OverwritePolicy that deletes records with a date before or on the given date in the specified column.

Records with an empty date value in existing data are also deleted.

Parameters:

attribute - date attribute to compare

end - last day (inclusive) up to which to delete data

byDateFromTo

public static OverwritePolicy byDateFromTo(String attribute,
                           Calendar start,
                           Calendar end)

Returns an OverwritePolicy that deletes records with a date between or on the given dates in the specified column.

Records with an empty date value in existing data are also deleted.

Parameters:

attribute - date attribute to compare

start - first day (inclusive) from which to delete data

end - last day (inclusive) up to which to delete data

toJson

public abstract com.fasterxml.jackson.databind.JsonNode toJson()

Builds this policy's JSON representation.

Returns:

this policy's JSON representation

getAttributeCodes

public List<String> getAttributeCodes()

Returns all attribute codes used in this policy. Can be used to check if a policy fits to a given data set.

Returns:

all attributes used in this policy