org.craftercms.studio.impl.v1.content.pipeline

Class BaseContentProcessor

java.lang.Object

org.craftercms.studio.impl.v1.content.pipeline.BaseContentProcessor

All Implemented Interfaces:

ContentProcessor

Direct Known Subclasses:

CleanPreviewContentProcessor, CleanWorkContentProcessor, DmWorkflowProcessor, ExtractParamsProcessor, FileFolderPathProcessor, FormNavOrderProcessor, InvalidateCacheProcessor, PathMatchProcessor, PostActivityProcessor

public class BaseContentProcessor
extends Object
implements ContentProcessor

A base class of content processor

Author:

hyanghee

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_name the default process name if not set
static String	NAME

Constructor Summary

Constructors

Constructor and Description
BaseContentProcessor() default constructor
BaseContentProcessor(String name) constructor that sets the process name

Method Summary

Modifier and Type	Method and Description
void	checkForMandatoryParam(String key, String value) check if the mandatory value provided is not empty
String	getName() get the name of this processor
boolean	isProcessable(PipelineContent content) determines if the content is processable by the given parameters
void	process(PipelineContent content, ResultTO result) process the content at the given path.
void	setName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

_name

protected String _name

the default process name if not set

Constructor Detail

BaseContentProcessor

public BaseContentProcessor()

default constructor

BaseContentProcessor

public BaseContentProcessor(String name)

constructor that sets the process name

Parameters:

name -

Method Detail

setName

public void setName(String name)

Parameters:

name - the name to set

getName

public String getName()

Description copied from interface: ContentProcessor

get the name of this processor

Specified by:

getName in interface ContentProcessor

Returns:

processor name

isProcessable

public boolean isProcessable(PipelineContent content)

Description copied from interface: ContentProcessor

determines if the content is processable by the given parameters

Specified by:

isProcessable in interface ContentProcessor

process

public void process(PipelineContent content,
                    ResultTO result)
             throws ContentProcessException,
                    SiteNotFoundException

Description copied from interface: ContentProcessor

process the content at the given path.

Specified by:

process in interface ContentProcessor

Parameters:

content - content to process

result - result to return

Throws:

ContentProcessException

SiteNotFoundException

checkForMandatoryParam

public void checkForMandatoryParam(String key,
                                   String value)
                            throws ContentProcessException

check if the mandatory value provided is not empty

Parameters:

key -

value -

Throws:

ContentProcessorException

ContentProcessException