org.springframework.data.hadoop.store.strategy.naming

Class AbstractFileNamingStrategy

java.lang.Object

org.springframework.data.hadoop.store.strategy.naming.AbstractFileNamingStrategy

All Implemented Interfaces:

org.springframework.core.Ordered, FileNamingStrategy, FileNamingStrategyFactory<FileNamingStrategy>

Direct Known Subclasses:

CodecFileNamingStrategy, RollingFileNamingStrategy, StaticFileNamingStrategy, UuidFileNamingStrategy

public abstract class AbstractFileNamingStrategy
extends java.lang.Object
implements FileNamingStrategy, org.springframework.core.Ordered

Base class for FileNamingStrategy implementations.

Also implements Ordered interface to be useful with ChainedFileNamingStrategy and OrderedComposite.

Enable information from method isEnabled() can be used in cases where strategy needs to be in place but perhaps should not be activated.

Author:

Janne Valkealahti

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractFileNamingStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
abstract FileNamingStrategy	createInstance() Creates a new instance of FileNamingStrategy.
CodecInfo	getCodecInfo() Gets the codec info.
int	getOrder() Implementation should override this method to define a chaining order.
org.apache.hadoop.fs.Path	init(org.apache.hadoop.fs.Path path) Initialises a starting state of a strategy.
boolean	isEnabled() Checks if strategy is enabled.
void	reset() Resets the strategy to its original state.
void	setCodecInfo(CodecInfo codecInfo) Sets the codec info.
void	setEnabled(boolean enabled) Sets if this strategy is enabled.
void	setOrder(int order) Sets the order.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.hadoop.store.strategy.naming.FileNamingStrategy

next, resolve

Constructor Detail

AbstractFileNamingStrategy

public AbstractFileNamingStrategy()

Method Detail

getOrder

public int getOrder()

Implementation should override this method to define a chaining order.

Specified by:

getOrder in interface org.springframework.core.Ordered

Returns:

the order value

See Also:

Ordered.getOrder()

setCodecInfo

public void setCodecInfo(CodecInfo codecInfo)

Description copied from interface: FileNamingStrategy

Sets the codec info.

Specified by:

setCodecInfo in interface FileNamingStrategy

Parameters:

codecInfo - the new codec info

init

public org.apache.hadoop.fs.Path init(org.apache.hadoop.fs.Path path)

Description copied from interface: FileNamingStrategy

Initialises a starting state of a strategy. Implementor of this method needs to check the final part of the Path and remove its own handled part if possible. Returned Path is then passed into next strategy for it to able to do its own initialisation logic.

Path passed to this method may be null indicating that no further processing should be done or simply we don't have information about the initialised path.

Specified by:

init in interface FileNamingStrategy

Parameters:

path - the path

Returns:

the path

reset

public void reset()

Description copied from interface: FileNamingStrategy

Resets the strategy to its original state.

Specified by:

reset in interface FileNamingStrategy

createInstance

public abstract FileNamingStrategy createInstance()

Description copied from interface: FileNamingStrategyFactory

Creates a new instance of FileNamingStrategy.

Specified by:

createInstance in interface FileNamingStrategyFactory<FileNamingStrategy>

Returns:

a new instance of file naming strategy

setOrder

public void setOrder(int order)

Sets the order.

Parameters:

order - the new order

See Also:

Ordered

getCodecInfo

public CodecInfo getCodecInfo()

Gets the codec info.

Returns:

the codec info

setEnabled

public void setEnabled(boolean enabled)

Sets if this strategy is enabled.

Parameters:

enabled - the new enabled

isEnabled

public boolean isEnabled()

Checks if strategy is enabled.

Returns:

true, if is enabled