Package ch.tocco.nice2.model.base.spi.base

Class AbstractXMLUnmarshallerModelBuilder

java.lang.Object

ch.tocco.nice2.model.base.spi.base.AbstractXMLUnmarshallerModelBuilder

All Implemented Interfaces:

NiceModelBuilder

Direct Known Subclasses:

AbstractXmlMenuBuilder, FormBuilder, RemoveFormBuilder, XMLFormBuilder, XMLFormRemove, XMLNiceEntityBuilder, XMLRelationBuilder, XMLRelationOverrideBuilder, XMLRemove, XMLTemplateBuilder

public abstract class AbstractXMLUnmarshallerModelBuilder
extends Object
implements NiceModelBuilder

An abstract model builder, which already sets up the history-writer, log etc.

Usage:

• Create subclass. Garanties that all arguments on the constructor aren't null.
• Create an instance (buildHandlerInstance(Object)) of an annotated class which can be interpreted by the Unmarshaller
• Provide the name of the first xml-tag in getFirstTag()

Field Summary

Fields

Modifier and Type	Field	Description
protected final DisplayValueFactory	displayValueFactory
protected final SAXParserFactory	factory
protected final org.slf4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractXMLUnmarshallerModelBuilder(org.slf4j.Logger log, DisplayValueFactory displayValueFactory)

Method Summary

Modifier and Type	Method	Description
protected void	afterParse(URI location)	Will be called after the parsing ended
protected boolean	beforeParse(URI location)	Will be called before the parsing begins.
protected abstract Object	buildHandlerInstance(Object receiver)	Return a new instance of a class, which can handle the event of the xml-unmarshaller
final void	buildModel(InputStream source, URI location, Object receiver)
protected abstract String	getFirstTag()	Return the name of the first xml-tag
protected boolean	shouldIgnoreUnhandledAttributes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.model.base.spi.base.NiceModelBuilder

getType

Field Details

log

protected final org.slf4j.Logger log

factory

protected final SAXParserFactory factory

displayValueFactory

protected final DisplayValueFactory displayValueFactory

Constructor Details

AbstractXMLUnmarshallerModelBuilder

protected AbstractXMLUnmarshallerModelBuilder(org.slf4j.Logger log,
 DisplayValueFactory displayValueFactory)

Method Details

buildHandlerInstance

protected abstract Object buildHandlerInstance(Object receiver)

Return a new instance of a class, which can handle the event of the xml-unmarshaller

State: It's guaranteed that all protected methods are set and valid

Parameters:

receiver - the receiver.

Returns:

the instance, non-null.

getFirstTag

protected abstract String getFirstTag()

Return the name of the first xml-tag

Returns:

non-null

buildModel

public final void buildModel(InputStream source,
 URI location,
 Object receiver)
                      throws ModelBuildException

Specified by:

buildModel in interface NiceModelBuilder

Parameters:

source - the source-stream. The stream gets closed by the caller.

location - the location as URI

receiver - the receiver

Throws:

ModelBuildException - if something went wrong

beforeParse

protected boolean beforeParse(URI location)

Will be called before the parsing begins.

Parameters:

location - the current location or null

Returns:

veto. if true the current location will not be parsed

afterParse

protected void afterParse(URI location)

Will be called after the parsing ended

Parameters:

location - the current location or null

shouldIgnoreUnhandledAttributes

protected boolean shouldIgnoreUnhandledAttributes()