Package org.mycore.tools

Class MyCoReWebPageProvider

java.lang.Object

org.mycore.tools.MyCoReWebPageProvider

public class MyCoReWebPageProvider
extends Object

This class provides a simple way to dynamically create MyCoRe webpages. These pages might be rendered through the layout service.
Example:

   MyCoReWebPageProvider wp = new MyCoReWebPageProvider();
   wp.addSection("Section Title", "Section Text", MyCoReWebPageProvider.DE);
   Document xml = wp.getXML();
   
   //call the layout service of an MCRServlet
   getLayoutService().doLayout(job.getRequest(), job.getResponse(), xml);
  

Author:

shermann, Matthias Eichner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT
static final String	DE	English language key
static final String	EN	German language key
static final String	TIME_FORMAT
static final String	XML_DATE
static final String	XML_LABELPATH
static final String	XML_LANG
static final String	XML_LASTEDITOR
static final String	XML_LOG
static final String	XML_META
static final String	XML_MYCORE_WEBPAGE
static final String	XML_SECTION
static final String	XML_TIME
static final String	XML_TITLE

Constructor Summary

Constructors

Constructor	Description
MyCoReWebPageProvider()

Method Summary

Modifier and Type	Method	Description
Element	addSection(String title, String xmlAsString, String lang)	Adds a section to the MyCoRe webpage.
Element	addSection(String title, List<Content> content, String lang)	Adds a section to the MyCoRe webpage
Element	addSection(String title, Content content, String lang)	Adds a section to the MyCoRe webpage.
Document	getXML()
void	updateMeta(String editor, String labelPath)	Updates the meta element of the webpage.

Methods inherited from class java.lang.Object

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

Field Details

EN

public static final String EN

German language key

See Also:

• Constant Field Values

DE

public static final String DE

English language key

See Also:

• Constant Field Values

XML_MYCORE_WEBPAGE

public static final String XML_MYCORE_WEBPAGE

See Also:

• Constant Field Values

XML_SECTION

public static final String XML_SECTION

See Also:

• Constant Field Values

XML_LANG

public static final String XML_LANG

See Also:

• Constant Field Values

XML_TITLE

public static final String XML_TITLE

See Also:

• Constant Field Values

XML_META

public static final String XML_META

See Also:

• Constant Field Values

XML_LOG

public static final String XML_LOG

See Also:

• Constant Field Values

XML_LASTEDITOR

public static final String XML_LASTEDITOR

See Also:

• Constant Field Values

XML_LABELPATH

public static final String XML_LABELPATH

See Also:

• Constant Field Values

XML_DATE

public static final String XML_DATE

See Also:

• Constant Field Values

XML_TIME

public static final String XML_TIME

See Also:

• Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

• Constant Field Values

TIME_FORMAT

public static final String TIME_FORMAT

See Also:

• Constant Field Values

Constructor Details

MyCoReWebPageProvider

public MyCoReWebPageProvider()

Method Details

addSection

public Element addSection(String title,
 String xmlAsString,
 String lang)
                   throws IOException,
SAXParseException,
JDOMException

Adds a section to the MyCoRe webpage.

Parameters:

title - the title of the section

xmlAsString - xml string which is added to the section

lang - the language of the section specified by a language key.

Returns:

added section

Throws:

IOException

SAXParseException

JDOMException

addSection

public Element addSection(String title,
 Content content,
 String lang)

Adds a section to the MyCoRe webpage.

Parameters:

title - the title of the section

content - jdom element which is added to the section

lang - the language of the section specified by a language key.

Returns:

added section

addSection

public Element addSection(String title,
 List<Content> content,
 String lang)

Adds a section to the MyCoRe webpage

Parameters:

title - the title of the section

content - list of content added to the section

lang - the language of the section specified by a language key.

Returns:

added section

updateMeta

public void updateMeta(String editor,
 String labelPath)

Updates the meta element of the webpage.

Parameters:

editor - last editor of webpage

labelPath - path info

getXML

public Document getXML()

Returns:

an xml document with root element is <MyCoReWebPage/>