Package org.craftercms.studio.api.v1.content.pipeline

Interface PipelineContent

All Known Implementing Classes:

PipelineContentImpl

public interface PipelineContent

wrapper to content that is being processed through the content processor pipeline

Author:

hyanghee

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_CONTENT_TYPE
static String	KEY_FILE_NAME
static String	KEY_PATH
static String	KEY_SITE

Method Summary

Modifier and Type	Method	Description
void	addProperty(String key, String value)	add a content property
void	closeContentStream()	close this content
InputStream	getContentStream()	get this content as input stream
org.dom4j.Document	getDocument()	get this content as XML Document
String	getEncoding()	get the encoding of this content
String	getId()	get the id of this content
Map<String,String>	getProperties()	get properties of this content
String	getProperty(String key)	get a property value given the key
void	setContentStream(InputStream contentStream)	set content input stream.this will reset document.
void	setDocument(org.dom4j.Document document)	set the content document.
void	setEncoding(String encoding)	set the encoding of this content
void	setId(String id)	set the id of this content
void	setProperties(Map<String,String> properties)	set content properties

Field Detail

KEY_CONTENT_TYPE

static final String KEY_CONTENT_TYPE

See Also:

Constant Field Values

KEY_FILE_NAME

static final String KEY_FILE_NAME

See Also:

Constant Field Values

KEY_SITE

static final String KEY_SITE

See Also:

Constant Field Values

KEY_PATH

static final String KEY_PATH

See Also:

Constant Field Values

Method Detail

getId

String getId()

get the id of this content

Returns:

id

setId

void setId(String id)

set the id of this content

Parameters:

id -

getContentStream

InputStream getContentStream()
                      throws ContentProcessException

get this content as input stream

Returns:

input stream

Throws:

ContentProcessException

setContentStream

void setContentStream(InputStream contentStream)

set content input stream.this will reset document.

Parameters:

contentStream -

getDocument

org.dom4j.Document getDocument()
                        throws ContentProcessException

get this content as XML Document

Returns:

document

Throws:

ContentProcessException

setDocument

void setDocument(org.dom4j.Document document)

set the content document. this will reset content stream

Parameters:

document -

getEncoding

String getEncoding()

get the encoding of this content

Returns:

encoding

setEncoding

void setEncoding(String encoding)

set the encoding of this content

Parameters:

encoding -

getProperties

Map<String,String> getProperties()

get properties of this content

Returns:

properties

setProperties

void setProperties(Map<String,String> properties)

set content properties

Parameters:

properties -

addProperty

void addProperty(String key,
                 String value)

add a content property

Parameters:

key -

value -

getProperty

String getProperty(String key)

get a property value given the key

Parameters:

key -

Returns:

property value

closeContentStream

void closeContentStream()

close this content