io.georocket.client

Class ImportParams

java.lang.Object

io.georocket.client.ImportParams

public class ImportParams
extends java.lang.Object

Parameters that can be passed to StoreClient.startImport(ImportParams, io.vertx.core.Handler)

Since:

1.3.0

Author:

Michel Kraemer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportParams.Compression A compression method

Constructor Summary

Constructors

Constructor and Description
ImportParams()

Method Summary

Modifier and Type	Method and Description
ImportParams	addProperties(java.util.Collection<java.lang.String> properties) Add items to the collection of properties to attach to the imported data
ImportParams	addProperties(java.lang.String... properties) Add items to the collection of properties to attach to the imported data
ImportParams	addProperty(java.lang.String property) Add a property to the collection of properties to attach to the imported data
ImportParams	addTag(java.lang.String tag) Add a tag to the collection of tags to attach to the imported data
ImportParams	addTags(java.util.Collection<java.lang.String> tags) Add items to the collection of tags to attach to the imported data
ImportParams	addTags(java.lang.String... tags) Add items to the collection of tags to attach to the imported data
boolean	equals(java.lang.Object o)
ImportParams.Compression	getCompression() Get the compression method
java.lang.String	getFallbackCRS() Get the CRS that should be used if the imported file does not specify one
java.lang.String	getLayer() Get the layer to import to
java.util.Collection<java.lang.String>	getProperties() Get the collection of properties to attach to the imported data
java.lang.Long	getSize() Get the size of data to be sent in bytes.
java.util.Collection<java.lang.String>	getTags() Get the collection of tags to attach to the imported data
int	hashCode()
ImportParams	setCompression(ImportParams.Compression compression) Set the compression method that is applied to the data that will be sent to the WriteStream returned by StoreClient.startImport(ImportParams, io.vertx.core.Handler).
ImportParams	setFallbackCRS(java.lang.String fallbackCRS) Set the CRS that should be used if the imported file does not specify one
ImportParams	setLayer(java.lang.String layer) Set the layer to import to
ImportParams	setProperties(java.util.Collection<java.lang.String> properties) Set a collection of properties to attach to the imported data
ImportParams	setSize(java.lang.Long size) Set the size of the data to be sent in bytes.
ImportParams	setTags(java.util.Collection<java.lang.String> tags) Set a collection of tags to attach to the imported data

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportParams

public ImportParams()

Method Detail

setLayer

public ImportParams setLayer(java.lang.String layer)

Set the layer to import to

Parameters:

layer - the layer (may be null if data should be imported to the root layer)

Returns:

a reference to this, so the API can be used fluently

getLayer

public java.lang.String getLayer()

Get the layer to import to

Returns:

the layer to import to (may be null if data should be imported to the root layer)

setTags

public ImportParams setTags(java.util.Collection<java.lang.String> tags)

Set a collection of tags to attach to the imported data

Parameters:

tags - the tags (may be null if no tags should be attached)

Returns:

a reference to this, so the API can be used fluently

addTags

public ImportParams addTags(java.util.Collection<java.lang.String> tags)

Add items to the collection of tags to attach to the imported data

Parameters:

tags - the tags to add

Returns:

a reference to this, so the API can be used fluently

addTags

public ImportParams addTags(java.lang.String... tags)

Add items to the collection of tags to attach to the imported data

Parameters:

tags - the tags to add

Returns:

a reference to this, so the API can be used fluently

addTag

public ImportParams addTag(java.lang.String tag)

Add a tag to the collection of tags to attach to the imported data

Parameters:

tag - the tag to add

Returns:

a reference to this, so the API can be used fluently

getTags

public java.util.Collection<java.lang.String> getTags()

Get the collection of tags to attach to the imported data

Returns:

the tags to attach to the imported data (null if no tags will be attached)

setProperties

public ImportParams setProperties(java.util.Collection<java.lang.String> properties)

Set a collection of properties to attach to the imported data

Parameters:

properties - the properties (may be null if no properties should be attached)

Returns:

a reference to this, so the API can be used fluently

addProperties

public ImportParams addProperties(java.util.Collection<java.lang.String> properties)

Add items to the collection of properties to attach to the imported data

Parameters:

properties - the properties to add

Returns:

a reference to this, so the API can be used fluently

addProperties

public ImportParams addProperties(java.lang.String... properties)

Add items to the collection of properties to attach to the imported data

Parameters:

properties - the properties to add

Returns:

a reference to this, so the API can be used fluently

addProperty

public ImportParams addProperty(java.lang.String property)

Add a property to the collection of properties to attach to the imported data

Parameters:

property - the property to add

Returns:

a reference to this, so the API can be used fluently

getProperties

public java.util.Collection<java.lang.String> getProperties()

Get the collection of properties to attach to the imported data

Returns:

the properties to attach to the imported data (null if no properties will be attached)

setSize

public ImportParams setSize(java.lang.Long size)

Set the size of the data to be sent in bytes. If compression is enabled (see setCompression(Compression)) this is the number of compressed bytes and not the size of the raw uncompressed data.

Parameters:

size - the size of data to be sent in bytes (may be null if unknown)

Returns:

a reference to this, so the API can be used fluently

getSize

public java.lang.Long getSize()

Get the size of data to be sent in bytes. If compression is enabled (see setCompression(Compression)) this is the number of compressed bytes and not the size of the raw uncompressed data.

Returns:

the size (may be null if unknown)

setFallbackCRS

public ImportParams setFallbackCRS(java.lang.String fallbackCRS)

Set the CRS that should be used if the imported file does not specify one

Parameters:

fallbackCRS - the CRS (may be null)

Returns:

a reference to this, so the API can be used fluently

getFallbackCRS

public java.lang.String getFallbackCRS()

Get the CRS that should be used if the imported file does not specify one

Returns:

the CRS

setCompression

public ImportParams setCompression(ImportParams.Compression compression)

Set the compression method that is applied to the data that will be sent to the WriteStream returned by StoreClient.startImport(ImportParams, io.vertx.core.Handler). The caller is responsible for compressing the data, for example by wrapping the WriteStream into a GzipWriteStream.

Parameters:

compression - the compression method (may be null if no compression should be used)

Returns:

a reference to this, so the API can be used fluently

getCompression

public ImportParams.Compression getCompression()

Get the compression method

Returns:

the compression method (never null)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object