RYXmlTransformer (RY utils library 2.4.4 API)

java.lang.Object
- com.playsql.utils.xml.RYXmlTransformer

public class RYXmlTransformer
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RYXmlTransformer.MacroDescription
The description of a macro, for example LinkLINKHE-1

Nested Classes
Modifier and Type	Class and Description
`static class`	`RYXmlTransformer.MacroDescription` The description of a macro, for example LinkLINKHE-1

Field Summary

Fields
Modifier and Type	Field and Description
`static QName`	`AC_IMAGE`
`static QName`	`AC_LAYOUT_CELL`
`static QName`	`AC_LINK`
`static QName`	`AC_MACRO`
`static QName`	`AC_MACRO_BODY`
`static QName`	`AC_MACRO_ID`
`static QName`	`AC_MACRO_NAME`
`static String`	`AC_NAMESPACE`
`static QName`	`AC_PARAM`
`static QName`	`AC_PLACEHOLDER`
`static QName`	`AC_SCHEMA_VERSION`
`static QName`	`AC_TASK`
`static QName`	`AC_TASK_BODY`
`protected static List<QName>`	`BLOCK_ELEMENTS`
`protected static List<QName>`	`NON_TEXT_ELEMENTS`
`static QName`	`W3_BLOCKQUOTE`
`static QName`	`W3_BR`
`static QName`	`W3_DIV`
`static QName`	`W3_H1`
`static QName`	`W3_H2`
`static QName`	`W3_H3`
`static QName`	`W3_H4`
`static QName`	`W3_H5`
`static QName`	`W3_H6`
`static QName`	`W3_HR`
`static QName`	`W3_IMG`
`static QName`	`W3_LI`
`static String`	`W3_NAMESPACE`
`static QName`	`W3_P`
`static QName`	`W3_PRE`
`static QName`	`W3_TABLE`
`static QName`	`W3_TBODY`
`static QName`	`W3_TD`
`static QName`	`W3_TH`
`static QName`	`W3_TR`

Constructor Summary

Constructors
Constructor and Description

RYXmlTransformer()

Constructors
Constructor and Description
`RYXmlTransformer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`closeQuietlyXml(XMLEventReader xml)`
`static void`	`closeQuietlyXml(XMLEventWriter xml)`
`protected void`	`end(XMLEventWriter out, QName name)`
`static String`	`getAttributeValue(XMLEvent event, QName attribute)`
`static String`	`getCharacters(List<XMLEvent> xml)`
`protected void`	`insertMacroParam(XMLEventWriter out, String key, Object value)`
`static boolean`	`isEnd(XMLEvent event, QName type)`
`static boolean`	`isMacroStart(XMLEvent event, String expectedMacroName)`
`static boolean`	`isStart(XMLEvent event, QName type)`
`static boolean`	`isWhitespace(List<XMLEvent> xml)` A stream is whitespace if doesn't contain or and everyting else is trimmed to blank.
`static RYXmlTransformer.MacroDescription`	`parseMacro(XMLEvent macroStartEvent, XMLEventReader reader)`
`protected void`	`start(XMLEventWriter out, QName name, org.apache.commons.lang3.tuple.Pair<QName,String>... attributes)`
`protected static void`	`text(XMLEventWriter out, Object text)`
`static void`	`textInParagraphs(XMLEventWriter xmlEventWriter, String comment)`
`void`	`writeMacro(XMLEventWriter out, RYXmlTransformer.MacroDescription macroDescription)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AC_NAMESPACE

public static final String AC_NAMESPACE

See Also:: Constant Field Values

W3_NAMESPACE

public static final String W3_NAMESPACE

See Also:: Constant Field Values

AC_MACRO
```
public static final QName AC_MACRO
```

AC_MACRO_NAME

public static final QName AC_MACRO_NAME

AC_MACRO_ID
```
public static final QName AC_MACRO_ID
```

AC_MACRO_BODY

public static final QName AC_MACRO_BODY

AC_PARAM
```
public static final QName AC_PARAM
```

AC_TASK
```
public static final QName AC_TASK
```

AC_TASK_BODY
```
public static final QName AC_TASK_BODY
```

AC_SCHEMA_VERSION

public static final QName AC_SCHEMA_VERSION

AC_LAYOUT_CELL

public static final QName AC_LAYOUT_CELL

AC_LINK
```
public static final QName AC_LINK
```

AC_IMAGE
```
public static final QName AC_IMAGE
```

AC_PLACEHOLDER

public static final QName AC_PLACEHOLDER

W3_TABLE
```
public static final QName W3_TABLE
```

W3_TBODY
```
public static final QName W3_TBODY
```

W3_TR
```
public static final QName W3_TR
```

W3_TD
```
public static final QName W3_TD
```

W3_TH
```
public static final QName W3_TH
```

W3_P
```
public static final QName W3_P
```

W3_LI
```
public static final QName W3_LI
```

W3_H1
```
public static final QName W3_H1
```

W3_H2
```
public static final QName W3_H2
```

W3_H3
```
public static final QName W3_H3
```

W3_H4
```
public static final QName W3_H4
```

W3_H5
```
public static final QName W3_H5
```

W3_H6
```
public static final QName W3_H6
```

W3_PRE
```
public static final QName W3_PRE
```

W3_BLOCKQUOTE

public static final QName W3_BLOCKQUOTE

W3_IMG
```
public static final QName W3_IMG
```

W3_BR
```
public static final QName W3_BR
```

W3_HR
```
public static final QName W3_HR
```

W3_DIV
```
public static final QName W3_DIV
```

BLOCK_ELEMENTS

protected static final List<QName> BLOCK_ELEMENTS

NON_TEXT_ELEMENTS

protected static final List<QName> NON_TEXT_ELEMENTS

Constructor Detail
- RYXmlTransformer
```
public RYXmlTransformer()
```

Method Detail

closeQuietlyXml

public static void closeQuietlyXml(XMLEventReader xml)

closeQuietlyXml

public static void closeQuietlyXml(XMLEventWriter xml)

text

protected static void text(XMLEventWriter out,
                           Object text)
                    throws XMLStreamException

Throws:: XMLStreamException

textInParagraphs

public static void textInParagraphs(XMLEventWriter xmlEventWriter,
                                    String comment)
                             throws XMLStreamException

Throws:: XMLStreamException

getCharacters

public static String getCharacters(List<XMLEvent> xml)

isWhitespace
```
public static boolean isWhitespace(List<XMLEvent> xml)
```
A stream is whitespace if doesn't contain or and everyting else is trimmed to blank.

start

@SafeVarargs
protected final void start(XMLEventWriter out,
                                        QName name,
                                        org.apache.commons.lang3.tuple.Pair<QName,String>... attributes)
                                 throws XMLStreamException

Throws:: XMLStreamException

insertMacroParam

protected void insertMacroParam(XMLEventWriter out,
                                String key,
                                Object value)
                         throws XMLStreamException

Throws:: XMLStreamException

writeMacro

public void writeMacro(XMLEventWriter out,
                       RYXmlTransformer.MacroDescription macroDescription)
                throws XMLStreamException

Throws:: XMLStreamException

end

protected void end(XMLEventWriter out,
                   QName name)
            throws XMLStreamException

Throws:: XMLStreamException

isStart

public static boolean isStart(XMLEvent event,
                              QName type)

isEnd

public static boolean isEnd(XMLEvent event,
                            QName type)

getAttributeValue

public static String getAttributeValue(XMLEvent event,
                                       QName attribute)

isMacroStart

public static boolean isMacroStart(XMLEvent event,
                                   String expectedMacroName)

parseMacro

public static RYXmlTransformer.MacroDescription parseMacro(XMLEvent macroStartEvent,
                                                           XMLEventReader reader)

Class RYXmlTransformer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AC_NAMESPACE

W3_NAMESPACE

AC_MACRO

AC_MACRO_NAME

AC_MACRO_ID

AC_MACRO_BODY

AC_PARAM

AC_TASK

AC_TASK_BODY

AC_SCHEMA_VERSION

AC_LAYOUT_CELL

AC_LINK

AC_IMAGE

AC_PLACEHOLDER

W3_TABLE

W3_TBODY

W3_TR

W3_TD

W3_TH

W3_P

W3_LI

W3_H1

W3_H2

W3_H3

W3_H4

W3_H5

W3_H6

W3_PRE

W3_BLOCKQUOTE

W3_IMG

W3_BR

W3_HR

W3_DIV

BLOCK_ELEMENTS

NON_TEXT_ELEMENTS

Constructor Detail

RYXmlTransformer

Method Detail

closeQuietlyXml

closeQuietlyXml

text

textInParagraphs

getCharacters

isWhitespace

start

insertMacroParam

writeMacro

end

isStart

isEnd

getAttributeValue

isMacroStart

parseMacro