Package com.evolveum.midpoint.prism.impl.lex.dom

Class DomLexicalProcessor

java.lang.Object

com.evolveum.midpoint.prism.impl.lex.dom.DomLexicalProcessor

All Implemented Interfaces:

LexicalProcessor<String>

public class DomLexicalProcessor
extends Object
implements LexicalProcessor<String>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.impl.lex.LexicalProcessor

LexicalProcessor.RootXNodeHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final Trace	LOGGER

Constructor Summary

Constructors

Constructor	Description
DomLexicalProcessor(@NotNull SchemaRegistry schemaRegistry)

Method Summary

Modifier and Type	Method	Description
boolean	canRead(@NotNull File file)	Checks if the processor can read from a given file.
boolean	canRead(@NotNull String dataString)	Checks if the processor can read from a given string.
@NotNull RootXNodeImpl	read(@NotNull ParserSource source, @NotNull ParsingContext parsingContext)
@NotNull List<RootXNodeImpl>	readObjects(@NotNull ParserSource source, @NotNull ParsingContext parsingContext)
void	readObjectsIteratively(@NotNull ParserSource source, @NotNull ParsingContext parsingContext, LexicalProcessor.RootXNodeHandler handler)
@NotNull String	write(@NotNull RootXNode xnode, SerializationContext serializationContext)	Serializes a root node into XNode tree.
@NotNull String	write(@NotNull XNode xnode, @NotNull QName rootElementName, SerializationContext serializationContext)	Serializes a non-root node into XNode tree.
@NotNull String	write(@NotNull List<RootXNodeImpl> roots, @Nullable SerializationContext context)	TODO Not supported for NullLexicalProcessor, though.
Element	writeXMapToElement(MapXNodeImpl xmap, QName elementName)	Deprecated.
@NotNull Element	writeXRootListToElement(@NotNull List<RootXNodeImpl> roots)
@NotNull Element	writeXRootToElement(@NotNull RootXNodeImpl xroot)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

public static final Trace LOGGER

Constructor Details

DomLexicalProcessor

public DomLexicalProcessor(@NotNull
 @NotNull SchemaRegistry schemaRegistry)

Method Details

read

@NotNull
public @NotNull RootXNodeImpl read(@NotNull
 @NotNull ParserSource source,
 @NotNull
 @NotNull ParsingContext parsingContext)
                            throws SchemaException,
IOException

Specified by:

read in interface LexicalProcessor<String>

Throws:

SchemaException

IOException

readObjects

@NotNull
public @NotNull List<RootXNodeImpl> readObjects(@NotNull
 @NotNull ParserSource source,
 @NotNull
 @NotNull ParsingContext parsingContext)
                                         throws SchemaException,
IOException

Specified by:

readObjects in interface LexicalProcessor<String>

Throws:

SchemaException

IOException

readObjectsIteratively

public void readObjectsIteratively(@NotNull
 @NotNull ParserSource source,
 @NotNull
 @NotNull ParsingContext parsingContext,
 LexicalProcessor.RootXNodeHandler handler)
                            throws SchemaException,
IOException

Specified by:

readObjectsIteratively in interface LexicalProcessor<String>

Throws:

SchemaException

IOException

canRead

public boolean canRead(@NotNull
 @NotNull File file)

Description copied from interface: LexicalProcessor

Checks if the processor can read from a given file. (Guessed by file extension, for now.) Used for autodetection of language.

Specified by:

canRead in interface LexicalProcessor<String>

canRead

public boolean canRead(@NotNull
 @NotNull String dataString)

Description copied from interface: LexicalProcessor

Checks if the processor can read from a given string. Note this is only an approximative information (for now). Used for autodetection of language.

Specified by:

canRead in interface LexicalProcessor<String>

write

@NotNull
public @NotNull String write(@NotNull
 @NotNull XNode xnode,
 @NotNull
 @NotNull QName rootElementName,
 SerializationContext serializationContext)
                      throws SchemaException

Description copied from interface: LexicalProcessor

Serializes a non-root node into XNode tree. So, xnode SHOULD NOT be a root node (at least for now). TODO consider removing - replacing by the previous form.

Specified by:

write in interface LexicalProcessor<String>

Throws:

SchemaException

write

@NotNull
public @NotNull String write(@NotNull
 @NotNull RootXNode xnode,
 SerializationContext serializationContext)
                      throws SchemaException

Description copied from interface: LexicalProcessor

Serializes a root node into XNode tree.

Specified by:

write in interface LexicalProcessor<String>

Throws:

SchemaException

write

@NotNull
public @NotNull String write(@NotNull
 @NotNull List<RootXNodeImpl> roots,
 @Nullable
 @Nullable SerializationContext context)
                      throws SchemaException

Description copied from interface: LexicalProcessor

TODO Not supported for NullLexicalProcessor, though.

Specified by:

write in interface LexicalProcessor<String>

Throws:

SchemaException

writeXRootListToElement

@NotNull
public @NotNull Element writeXRootListToElement(@NotNull
 @NotNull List<RootXNodeImpl> roots)
                                         throws SchemaException

Throws:

SchemaException

writeXMapToElement

@Deprecated
public Element writeXMapToElement(MapXNodeImpl xmap,
 QName elementName)
                           throws SchemaException

Deprecated.

Seems to be used in strange circumstances (called from various hacks). To be reconsidered eventually. Avoid using in new code.

Throws:

SchemaException

writeXRootToElement

@NotNull
public @NotNull Element writeXRootToElement(@NotNull
 @NotNull RootXNodeImpl xroot)
                                     throws SchemaException

Throws:

SchemaException