Package net.sf.basedb.plugins.batchimport

Class FileImporter.PathIdMethod

java.lang.Object

net.sf.basedb.plugins.batchimport.FileImporter.PathIdMethod

All Implemented Interfaces:

IdMethod

Enclosing class:

FileImporter

public static class FileImporter.PathIdMethod
extends Object
implements IdMethod

Field Summary

Fields

Modifier and Type	Field	Description
static FallbackIdMethod	PATH_OR_ID
static final FileImporter.PathIdMethod	ROOT
private final String	rootPath

Constructor Summary

Constructors

Constructor	Description
PathIdMethod(String rootPath)

Method Summary

Modifier and Type	Method	Description
<I extends BasicItem> List<I>	find(DbControl dc, ItemQuery<I> query, String identifier)	Try to find items with this query method.
String	getColumnMappingParameterName()
String	getMethod()	The name of this method, which should be unique among the methods that can be used at a given time.
String	getTitle()	The display title of the method.
boolean	isTrulyUnique()	If the identification method is truly unique or not.
<I extends BasicItem> ItemQuery<I>	prepareQuery(DbControl dc, ItemQuery<I> query)	Initialise a query to be used by this identification method.
String	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

ROOT

public static final FileImporter.PathIdMethod ROOT

PATH_OR_ID

public static FallbackIdMethod PATH_OR_ID

rootPath

private final String rootPath

Constructor Details

PathIdMethod

public PathIdMethod(String rootPath)

Method Details

getMethod

public String 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.

Specified by:

getMethod in interface IdMethod

Returns:

The method name

getTitle

public String getTitle()

Description copied from interface: IdMethod

The display title of the method.

Specified by:

getTitle in interface IdMethod

isTrulyUnique

public boolean isTrulyUnique()

Description copied from interface: IdMethod

If the identification method is truly unique or not. If this method returns true, the IdMethod.find(DbControl, ItemQuery, String) method will never ever return a list with more than one item.

Specified by:

isTrulyUnique in interface IdMethod

getColumnMappingParameterName

public String getColumnMappingParameterName()

Specified by:

getColumnMappingParameterName in interface IdMethod

prepareQuery

public <I extends BasicItem> ItemQuery<I> prepareQuery(DbControl dc,
 ItemQuery<I> query)

Description copied from interface: IdMethod

Initialise a query to be used by this identification method. The query should be a fresh query without any previous restrictions or other modifications.

Specified by:

prepareQuery in interface IdMethod

query - The query to prepare

Returns:

The query that is used for item lookup

find

public <I extends BasicItem> List<I> find(DbControl dc,
 ItemQuery<I> query,
 String identifier)

Description copied from interface: IdMethod

Try to find items with this query method.

Specified by:

find in interface IdMethod

query - The query to use, which should have been prepared using IdMethod.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

public String toString()

Overrides:

toString in class Object