|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ParentChildCreatorInterface
Field Summary | |
---|---|
static short |
BRANCH_NODE
Constant for a branch node. |
static short |
LEAF_NODE
Constant for a leaf node. |
Method Summary | |
---|---|
void |
create(Publication publication,
java.io.File samplesDir,
java.io.File parentDir,
java.lang.String parentId,
java.lang.String childId,
short childType,
java.lang.String childName,
java.lang.String language,
java.util.Map parameters)
Create a new document. |
java.lang.String |
generateTreeId(java.lang.String childId,
short childType)
Describe generateTreeId method here. |
java.lang.String |
getChildName(java.lang.String childname)
Describe getChildName method here. |
short |
getChildType(short childType)
Return the type of node this creator will create. |
void |
init(org.apache.avalon.framework.configuration.Configuration doctypeConf)
Configures the Creator, based on a configuration file. |
Field Detail |
---|
static final short BRANCH_NODE
static final short LEAF_NODE
Method Detail |
---|
void init(org.apache.avalon.framework.configuration.Configuration doctypeConf)
doctypeConf
- A configuration.short getChildType(short childType) throws java.lang.Exception
BRANCH_NODE
or LEAF_NODE
. An
implementation can simply return the input parameter (which can
be used to pass in a request parameter) or choose to ignore it.
childType
- a short
value
short
value (either BRANCH_NODE
or LEAF_NODE
)
java.lang.Exception
- if an error occursjava.lang.String getChildName(java.lang.String childname) throws java.lang.Exception
getChildName
method here.
childname
- a String
value
String
value
java.lang.Exception
- if an error occursjava.lang.String generateTreeId(java.lang.String childId, short childType) throws java.lang.Exception
generateTreeId
method here.
childId
- a String
valuechildType
- a short
value
String
value
java.lang.Exception
- if an error occursvoid create(Publication publication, java.io.File samplesDir, java.io.File parentDir, java.lang.String parentId, java.lang.String childId, short childType, java.lang.String childName, java.lang.String language, java.util.Map parameters) throws java.lang.Exception
publication
- the publication context.samplesDir
- the directory where the template file is located.parentDir
- in which directory the document is to be created.parentId
- the parent id of the new documentchildId
- the document id of the new documentchildType
- the type of the new document.childName
- the name of the new document.language
- for which the document is created.parameters
- additional parameters that can be used when creating the child
java.lang.Exception
- if an error occurs
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |