Class PropertyIdMethod
java.lang.Object
net.sf.basedb.plugins.batchimport.PropertyIdMethod
- All Implemented Interfaces:
IdMethod
Identification method implementation that can use a single property
(eg, name, id, externalId, etc.) for identifying items.
- Version:
- 2.8
- Author:
- nicklas
- Last modified
- $Date: 2011-03-16 12:48:47 +0100 (on, 16 mar 2011) $
-
Field Summary
Modifier and TypeFieldDescriptionstatic final PropertyIdMethod
Use the barcode for finding items.private final String
static final PropertyIdMethod
Use the external ID for finding items.private final String
static final PropertyIdMethod
Use the name for finding items.private final String
private final String
private final boolean
private final Type
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionFind all items withproperty = identifier
.The name of this method, which should be unique among the methods that can be used at a given time.getTitle()
The display title of the method.boolean
If the identification method is truly unique or not.prepareQuery
(DbControl dc, ItemQuery<I> query) Adds a restriction to the query:property = :identifier
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.basedb.plugins.batchimport.IdMethod
setIdentifierOnNewItem
-
Field Details
-
NAME
Use the name for finding items. -
EXTERNAL_ID
Use the external ID for finding items. -
BARCODE
Use the barcode for finding items. -
method
-
property
-
columnMappingParameterName
-
title
-
unique
private final boolean unique -
valueType
-
-
Constructor Details
-
PropertyIdMethod
public PropertyIdMethod(String method, String title, String property, String columnMappingParameterName, boolean unique, Type valueType) Create a new id method.- Parameters:
method
- The method name, which should be unique among all methodstitle
- The title to use for display purposesproperty
- The name of the property to filter on when using this id methodunique
- If this property is guaranteed to be unique or notvalueType
- The type of values
-
-
Method Details
-
getMethod
Description copied from interface:IdMethod
The name of this method, which should be unique among the methods that can be used at a given time. -
getTitle
Description copied from interface:IdMethod
The display title of the method. -
getColumnMappingParameterName
- Specified by:
getColumnMappingParameterName
in interfaceIdMethod
-
isTrulyUnique
public boolean isTrulyUnique()Description copied from interface:IdMethod
If the identification method is truly unique or not. If this method returns true, theIdMethod.find(DbControl, ItemQuery, String)
method will never ever return a list with more than one item.- Specified by:
isTrulyUnique
in interfaceIdMethod
-
prepareQuery
Adds a restriction to the query:property = :identifier
- Specified by:
prepareQuery
in interfaceIdMethod
query
- The query to prepare- Returns:
- The query that is used for item lookup
-
find
Find all items withproperty = identifier
.- Specified by:
find
in interfaceIdMethod
query
- The query to use, which should have been prepared usingIdMethod.prepareQuery(DbControl, ItemQuery)
identifier
- The identifier of the item- Returns:
- A list with the found items, if
IdMethod.isTrulyUnique()
return true the list is guaranteed to have at most one item
-
toString
-
getProperty
-
getValueType
-