Package org.hippoecm.hst.configuration.channel

Class Blueprint

java.lang.Object

org.hippoecm.hst.configuration.channel.Blueprint

public class Blueprint
extends Object

A Blueprint is provided by the developers to create and manage channels by the ChannelManager, and is defined by the node type hst:blueprint. Please see the hst.cnd for the node type definition

Constructor Summary

Constructors

Constructor	Description
Blueprint()

Method Summary

Modifier and Type	Method	Description
static Blueprint	copy(Blueprint source)
String	getContentRoot()	Get the Blueprint content root must start with a / and be a valid JCR path
String	getDescription()	Get value of hst:description of the Blueprint if available, null otherwise
boolean	getHasContentPrototype()	Does the Blueprint have a content prototype.
String	getId()	Get Blueprint id
String	getName()	Get the name of the Blueprint as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name
String	getPath()	Get the normalized absolute path
Channel	getPrototypeChannel()	Get prototype Channel which is never null.
void	setContentRoot(String contentRoot)	Set Blueprint content root
void	setDescription(String description)	Set the Blueprint description
void	setHasContentPrototype(boolean hasContentPrototype)	Set whether a Blueprint has content prototype or not
void	setId(String id)	Set Blueprint id
void	setName(String name)	Set the Blueprint name
void	setPath(String path)	Set the normalized absolute path
void	setPrototypeChannel(Channel prototypeChannel)	Set the prototype Channel
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Blueprint

public Blueprint()

Method Detail

copy

public static Blueprint copy(Blueprint source)

getId

public String getId()

Get Blueprint id

Returns:

The Blueprint id

setId

public void setId(String id)

Set Blueprint id

Parameters:

id - - The Blueprint id

getName

public String getName()

Get the name of the Blueprint as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name

Returns:

The name of the Blueprint

setName

public void setName(String name)

Set the Blueprint name

Parameters:

name - - The Blueprint name to set

getDescription

public String getDescription()

Get value of hst:description of the Blueprint if available, null otherwise

Returns:

The Blueprint description

setDescription

public void setDescription(String description)

Set the Blueprint description

Parameters:

description - The Blueprint description to set

getContentRoot

public String getContentRoot()

Get the Blueprint content root must start with a / and be a valid JCR path

Returns:

Absolute path of the hst:contentRoot of the Blueprint if available, null otherwise

setContentRoot

public void setContentRoot(String contentRoot)

Set Blueprint content root

Parameters:

contentRoot - - The Blueprint content root to set

getHasContentPrototype

public boolean getHasContentPrototype()

Does the Blueprint have a content prototype. If so, it will be used to create a content structure

Returns:

true if a prototype exists, false otherwise

setHasContentPrototype

public void setHasContentPrototype(boolean hasContentPrototype)

Set whether a Blueprint has content prototype or not

Parameters:

hasContentPrototype - - The Blueprint getHasContentPrototype flag value to set

getPrototypeChannel

public Channel getPrototypeChannel()

Get prototype Channel which is never null. The returned Channel does also never return null for Channel.getContextPath()

Returns:

The prototype Channel which is never null. The returned Channel does also never return null for Channel.getContextPath()

setPrototypeChannel

public void setPrototypeChannel(Channel prototypeChannel)

Set the prototype Channel

Parameters:

prototypeChannel - - The prototype Channel to set

getPath

public String getPath()

Get the normalized absolute path

Returns:

The normalized absolute path

setPath

public void setPath(String path)

Set the normalized absolute path

Parameters:

path - - The normalized absolute path to set

toString

public String toString()

Overrides:

toString in class Object