org.springframework.data.hadoop.store.config.annotation.builders

Class DataStoreTextWriterBuilder

java.lang.Object

org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder<O>

org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<org.springframework.beans.factory.config.BeanDefinition,DataStoreTextWriterConfigurer,DataStoreTextWriterBuilder>

org.springframework.data.hadoop.store.config.annotation.builders.DataStoreTextWriterBuilder

All Implemented Interfaces:

AnnotationBuilder<org.springframework.beans.factory.config.BeanDefinition>, DataStoreTextWriterConfigurer

public final class DataStoreTextWriterBuilder
extends AbstractConfiguredAnnotationBuilder<org.springframework.beans.factory.config.BeanDefinition,DataStoreTextWriterConfigurer,DataStoreTextWriterBuilder>
implements DataStoreTextWriterConfigurer

AnnotationBuilder for BeanDefinition of a DataStoreWriter.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
DataStoreTextWriterBuilder() Instantiates a new data store writer builder.
DataStoreTextWriterBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor) Instantiates a new data store writer builder.

Method Summary

Methods

Modifier and Type	Method and Description
DataStoreTextWriterConfigurer	append(boolean append) Specify if writer is allowed to do file append.
DataStoreTextWriterConfigurer	basePath(org.apache.hadoop.fs.Path basePath) Specify a writer's base path.
DataStoreTextWriterConfigurer	basePath(java.lang.String basePath) Specify a writer's base path.
DataStoreTextWriterConfigurer	codec(CodecInfo codec) Specify a writer's compression coded.
DataStoreTextWriterConfigurer	codec(Codecs codec) Specify a writer's compression coded.
DataStoreTextWriterConfigurer	codec(java.lang.String codec) Specify a writer's compression coded.
DataStoreTextWriterConfigurer	configuration(org.apache.hadoop.conf.Configuration configuration) Specify a writer's Hadoop configuration.
DataStoreTextWriterConfigurer	fileOpenAttempts(int attempts) Specify a writer's max file open attempts.
DataStoreTextWriterConfigurer	idleTimeout(long timeout) Specify a writer's idle timeout.
DataStoreTextWriterConfigurer	inWritingPrefix(java.lang.String prefix) Specify a writer's in-use prefix.
DataStoreTextWriterConfigurer	inWritingSuffix(java.lang.String suffix) Specify a writer's in-use suffix.
DataStoreTextWriterConfigurer	overwrite(boolean overwrite) Specify if writer is allowed to overwrite files.
protected org.springframework.beans.factory.config.BeanDefinition	performBuild() Subclasses must implement this method to build the object that is being returned.
void	setFileNamingStrategy(FileNamingStrategy fileNamingStrategy) Sets the file naming strategy for this builder.
void	setPartitionStrategy(PartitionStrategy<?,?> partitionStrategy) Sets the partition strategy for this builder.
void	setRolloverStrategy(RolloverStrategy rolloverStrategy) Sets the rollover strategy for this builder.
NamingStrategyConfigurer	withNamingStrategy() Specify a writer's naming strategy.
PartitionStrategyConfigurer	withPartitionStrategy() Specify a writer's partition strategy.
RolloverStrategyConfigurer	withRolloverStrategy() Specify a writer's rollover strategy.

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder

apply, apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObject

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder

build, getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStoreTextWriterBuilder

public DataStoreTextWriterBuilder()

Instantiates a new data store writer builder.

DataStoreTextWriterBuilder

public DataStoreTextWriterBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor)

Instantiates a new data store writer builder.

Parameters:

objectPostProcessor - the object post processor

Method Detail

performBuild

protected org.springframework.beans.factory.config.BeanDefinition performBuild()
                                                                        throws java.lang.Exception

Description copied from class: AbstractConfiguredAnnotationBuilder

Subclasses must implement this method to build the object that is being returned.

Specified by:

performBuild in class AbstractConfiguredAnnotationBuilder<org.springframework.beans.factory.config.BeanDefinition,DataStoreTextWriterConfigurer,DataStoreTextWriterBuilder>

Returns:

Object build by this builder

Throws:

java.lang.Exception

configuration

public DataStoreTextWriterConfigurer configuration(org.apache.hadoop.conf.Configuration configuration)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's Hadoop configuration.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .configuration(new Configuration());
 }
 

XML:
No equivalent

Specified by:

configuration in interface DataStoreTextWriterConfigurer

Parameters:

configuration - the hadoop configuration

Returns:

DataStoreTextWriterConfigurer for chaining

basePath

public DataStoreTextWriterConfigurer basePath(org.apache.hadoop.fs.Path basePath)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's base path.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .basePath(new Path("/my/path"));
 }
 

XML:
No equivalent

Specified by:

basePath in interface DataStoreTextWriterConfigurer

Parameters:

basePath - the path

Returns:

DataStoreTextWriterConfigurer for chaining

basePath

public DataStoreTextWriterConfigurer basePath(java.lang.String basePath)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's base path.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .basePath("/my/path");
 }
 

XML:
No equivalent

Specified by:

basePath in interface DataStoreTextWriterConfigurer

Parameters:

basePath - the path

Returns:

DataStoreTextWriterConfigurer for chaining

codec

public DataStoreTextWriterConfigurer codec(CodecInfo codec)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's compression coded.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .codec(Codecs.BZIP2.getCodecInfo());
 }
 

XML:
No equivalent

Specified by:

codec in interface DataStoreTextWriterConfigurer

Parameters:

codec - the codec

Returns:

DataStoreTextWriterConfigurer for chaining

codec

public DataStoreTextWriterConfigurer codec(java.lang.String codec)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's compression coded.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .codec("gzip");
 }
 

XML:
No equivalent

Specified by:

codec in interface DataStoreTextWriterConfigurer

Parameters:

codec - the codec

Returns:

DataStoreTextWriterConfigurer for chaining

codec

public DataStoreTextWriterConfigurer codec(Codecs codec)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's compression coded.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .codec(Codecs.BZIP2);
 }
 

XML:
No equivalent

Specified by:

codec in interface DataStoreTextWriterConfigurer

Parameters:

codec - the codec

Returns:

DataStoreTextWriterConfigurer for chaining

overwrite

public DataStoreTextWriterConfigurer overwrite(boolean overwrite)

Description copied from interface: DataStoreTextWriterConfigurer

Specify if writer is allowed to overwrite files.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .overwrite(false);
 }
 

XML:
No equivalent

Specified by:

overwrite in interface DataStoreTextWriterConfigurer

Parameters:

overwrite - enable overwrite

Returns:

DataStoreTextWriterConfigurer for chaining

append

public DataStoreTextWriterConfigurer append(boolean append)

Description copied from interface: DataStoreTextWriterConfigurer

Specify if writer is allowed to do file append.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .append(false);
 }
 

XML:
No equivalent

Specified by:

append in interface DataStoreTextWriterConfigurer

Parameters:

append - enable append support

Returns:

DataStoreTextWriterConfigurer for chaining

inWritingPrefix

public DataStoreTextWriterConfigurer inWritingPrefix(java.lang.String prefix)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's in-use prefix.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .inWritingPrefix("myprefix");
 }
 

XML:
No equivalent

Specified by:

inWritingPrefix in interface DataStoreTextWriterConfigurer

Parameters:

prefix - the in-writing prefix

Returns:

DataStoreTextWriterConfigurer for chaining

inWritingSuffix

public DataStoreTextWriterConfigurer inWritingSuffix(java.lang.String suffix)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's in-use suffix.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .inWritingSuffix("mysuffix");
 }
 

XML:
No equivalent

Specified by:

inWritingSuffix in interface DataStoreTextWriterConfigurer

Parameters:

suffix - the in-writing suffix

Returns:

DataStoreTextWriterConfigurer for chaining

idleTimeout

public DataStoreTextWriterConfigurer idleTimeout(long timeout)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's idle timeout.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .idleTimeout(60000);
 }
 

XML:
No equivalent

Specified by:

idleTimeout in interface DataStoreTextWriterConfigurer

Parameters:

timeout - the idle timeout

Returns:

DataStoreTextWriterConfigurer for chaining

fileOpenAttempts

public DataStoreTextWriterConfigurer fileOpenAttempts(int attempts)

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's max file open attempts.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .fileOpenAttempts(10);
 }
 

XML:
No equivalent

Specified by:

fileOpenAttempts in interface DataStoreTextWriterConfigurer

Parameters:

attempts - the attemps count

Returns:

DataStoreTextWriterConfigurer for chaining

withPartitionStrategy

public PartitionStrategyConfigurer withPartitionStrategy()
                                                  throws java.lang.Exception

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's partition strategy. Applies a new DefaultPartitionStrategyConfigurer into current builder.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .withPartitionStrategy()
       .map("spelexpression");
 }
 

XML:
No equivalent

Specified by:

withPartitionStrategy in interface DataStoreTextWriterConfigurer

Returns:

PartitionStrategyConfigurer for chaining

Throws:

java.lang.Exception - exception

withNamingStrategy

public NamingStrategyConfigurer withNamingStrategy()
                                            throws java.lang.Exception

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's naming strategy. Applies a new DefaultNamingStrategyConfigurer into current builder.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .withNamingStrategy()
       .name("foo")
       .uuid()
       .rolling()
       .codec();
 }
 

XML:
No equivalent

Specified by:

withNamingStrategy in interface DataStoreTextWriterConfigurer

Returns:

NamingStrategyConfigurer for chaining

Throws:

java.lang.Exception - exception

withRolloverStrategy

public RolloverStrategyConfigurer withRolloverStrategy()
                                                throws java.lang.Exception

Description copied from interface: DataStoreTextWriterConfigurer

Specify a writer's rollover strategy. Applies a new DefaultRolloverStrategyConfigurer into current builder.

JavaConfig:

 public void configure(DataStoreTextWriterConfigurer writer) throws Exception {
   writer
     .withRolloverStrategy()
       .size("1M");
 }
 

XML:
No equivalent

Specified by:

withRolloverStrategy in interface DataStoreTextWriterConfigurer

Returns:

RolloverStrategyConfigurer for chaining

Throws:

java.lang.Exception - exception

setPartitionStrategy

public void setPartitionStrategy(PartitionStrategy<?,?> partitionStrategy)

Sets the partition strategy for this builder.

Parameters:

partitionStrategy - the partition strategy

setFileNamingStrategy

public void setFileNamingStrategy(FileNamingStrategy fileNamingStrategy)

Sets the file naming strategy for this builder.

Parameters:

fileNamingStrategy - the new file naming strategy

setRolloverStrategy

public void setRolloverStrategy(RolloverStrategy rolloverStrategy)

Sets the rollover strategy for this builder.

Parameters:

rolloverStrategy - the new rollover strategy