|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FastInfosetSerializer
A general interface for serializers of fast infoset documents.
This interface contains common methods that are not specific to any API associated with the serialization of XML Infoset to fast infoset documents.
Field Summary | |
---|---|
static int |
ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINT
The default value for limit on the size of indexed Map for character content chunks Limit is measured in bytes not in number of entries |
static int |
ATTRIBUTE_VALUE_SIZE_CONSTRAINT
The default value for the limit on the size of attribute values that will be indexed. |
static java.lang.String |
BUFFER_SIZE_PROPERTY
The property name to be used for getting and setting the buffer size of a parser. |
static int |
CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINT
The default value for limit on the size of indexed Map for attribute values Limit is measured in bytes not in number of entries |
static int |
CHARACTER_CONTENT_CHUNK_SIZE_CONSTRAINT
The default value for the limit on the size of character content chunks that will be indexed. |
static java.lang.String |
EXTERNAL_VOCABULARIES_PROPERTY
The property name to be used for getting and setting the Map containing external vocabularies. |
static java.lang.String |
IGNORE_COMMENTS_FEATURE
The feature to ignore comments. |
static java.lang.String |
IGNORE_DTD_FEATURE
The feature to ignore the document type declaration and the internal subset. |
static java.lang.String |
IGNORE_PROCESSING_INSTRUCTIONS_FEATURE
The feature to ignore processing instructions. |
static java.lang.String |
IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE
The feature to ignore text content that consists completely of white space characters. |
static java.lang.String |
REGISTERED_ENCODING_ALGORITHMS_PROPERTY
The property name to be used for getting and setting the Map containing encoding algorithms. |
static java.lang.String |
UTF_16BE
The character encoding scheme string for UTF-16BE. |
static java.lang.String |
UTF_8
The character encoding scheme string for UTF-8. |
Method Summary | |
---|---|
int |
getAttributeValueMapMemoryLimit()
Gets the limit on the memory size of Map of attribute values that will be indexed. |
int |
getAttributeValueSizeLimit()
Gets the limit on the size of attribute values that will be indexed. |
int |
getCharacterContentChunkMapMemoryLimit()
Gets the limit on the memory size of Map of attribute values that will be indexed. |
int |
getCharacterContentChunkSizeLimit()
Gets the limit on the size of character content chunks that will be indexed. |
java.lang.String |
getCharacterEncodingScheme()
Gets the character encoding scheme. |
boolean |
getIgnoreComments()
Get the IGNORE_COMMENTS_FEATURE . |
boolean |
getIgnoreDTD()
Get the IGNORE_DTD_FEATURE . |
boolean |
getIgnoreProcesingInstructions()
Get the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE . |
boolean |
getIgnoreWhiteSpaceTextContent()
Get the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE . |
java.util.Map |
getRegisteredEncodingAlgorithms()
Gets the set of registered encoding algorithms. |
VocabularyApplicationData |
getVocabularyApplicationData()
Get the application data associated with the serializer vocabulary. |
void |
reset()
Reset the serializer for reuse serializing another XML infoset. |
void |
setAttributeValueMapMemoryLimit(int size)
Sets the limit on the memory size of Map of attribute values that will be indexed. |
void |
setAttributeValueSizeLimit(int size)
Sets the limit on the size of attribute values that will be indexed. |
void |
setCharacterContentChunkMapMemoryLimit(int size)
Sets the limit on the memory size of Map of attribute values that will be indexed. |
void |
setCharacterContentChunkSizeLimit(int size)
Sets the limit on the size of character content chunks that will be indexed. |
void |
setCharacterEncodingScheme(java.lang.String characterEncodingScheme)
Sets the character encoding scheme. |
void |
setExternalVocabulary(ExternalVocabulary v)
Set the external vocabulary that shall be used when serializing. |
void |
setIgnoreComments(boolean ignoreComments)
Set the IGNORE_COMMENTS_FEATURE . |
void |
setIgnoreDTD(boolean ignoreDTD)
Set the IGNORE_DTD_FEATURE . |
void |
setIgnoreProcesingInstructions(boolean ignoreProcesingInstructions)
Set the IGNORE_PROCESSING_INSTRUCTIONS_FEATURE . |
void |
setIgnoreWhiteSpaceTextContent(boolean ignoreWhiteSpaceTextContent)
Set the IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE . |
void |
setOutputStream(java.io.OutputStream s)
Set the OutputStream to serialize the XML infoset to a fast infoset document. |
void |
setRegisteredEncodingAlgorithms(java.util.Map algorithms)
Sets the set of registered encoding algorithms. |
void |
setVocabularyApplicationData(VocabularyApplicationData data)
Set the application data to be associated with the serializer vocabulary. |
Field Detail |
---|
static final java.lang.String IGNORE_DTD_FEATURE
The default value is false. If true a serializer shall ignore document type declaration and the internal subset.
static final java.lang.String IGNORE_COMMENTS_FEATURE
The default value is false. If true a serializer shall ignore comments and shall not serialize them.
static final java.lang.String IGNORE_PROCESSING_INSTRUCTIONS_FEATURE
The default value is false. If true a serializer shall ignore processing instructions and shall not serialize them.
static final java.lang.String IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE
The default value is false. If true a serializer shall ignore text content that consists completely of white space characters.
static final java.lang.String BUFFER_SIZE_PROPERTY
static final java.lang.String REGISTERED_ENCODING_ALGORITHMS_PROPERTY
static final java.lang.String EXTERNAL_VOCABULARIES_PROPERTY
static final int CHARACTER_CONTENT_CHUNK_SIZE_CONSTRAINT
static final int CHARACTER_CONTENT_CHUNK_MAP_MEMORY_CONSTRAINT
static final int ATTRIBUTE_VALUE_SIZE_CONSTRAINT
static final int ATTRIBUTE_VALUE_MAP_MEMORY_CONSTRAINT
static final java.lang.String UTF_8
static final java.lang.String UTF_16BE
Method Detail |
---|
void setIgnoreDTD(boolean ignoreDTD)
IGNORE_DTD_FEATURE
.
ignoreDTD
- true if the feature shall be ignored.boolean getIgnoreDTD()
IGNORE_DTD_FEATURE
.
void setIgnoreComments(boolean ignoreComments)
IGNORE_COMMENTS_FEATURE
.
ignoreComments
- true if the feature shall be ignored.boolean getIgnoreComments()
IGNORE_COMMENTS_FEATURE
.
void setIgnoreProcesingInstructions(boolean ignoreProcesingInstructions)
IGNORE_PROCESSING_INSTRUCTIONS_FEATURE
.
ignoreProcesingInstructions
- true if the feature shall be ignored.boolean getIgnoreProcesingInstructions()
IGNORE_PROCESSING_INSTRUCTIONS_FEATURE
.
void setIgnoreWhiteSpaceTextContent(boolean ignoreWhiteSpaceTextContent)
IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE
.
ignoreWhiteSpaceTextContent
- true if the feature shall be ignored.boolean getIgnoreWhiteSpaceTextContent()
IGNORE_WHITE_SPACE_TEXT_CONTENT_FEATURE
.
void setCharacterEncodingScheme(java.lang.String characterEncodingScheme)
characterEncodingScheme
- The set of registered algorithms.java.lang.String getCharacterEncodingScheme()
void setRegisteredEncodingAlgorithms(java.util.Map algorithms)
algorithms
- The set of registered algorithms.java.util.Map getRegisteredEncodingAlgorithms()
void setCharacterContentChunkSizeLimit(int size)
size
- The character content chunk size limit. Any chunk less
that a length of size limit will be indexed.int getCharacterContentChunkSizeLimit()
void setCharacterContentChunkMapMemoryLimit(int size)
size
- The attribute value size limit. Any value less
that a length of size limit will be indexed.int getCharacterContentChunkMapMemoryLimit()
void setAttributeValueSizeLimit(int size)
size
- The attribute value size limit. Any value less
that a length of size limit will be indexed.int getAttributeValueSizeLimit()
void setAttributeValueMapMemoryLimit(int size)
size
- The attribute value size limit. Any value less
that a length of size limit will be indexed.int getAttributeValueMapMemoryLimit()
void setExternalVocabulary(ExternalVocabulary v)
v
- the vocabulary.void setVocabularyApplicationData(VocabularyApplicationData data)
data
- the application data.VocabularyApplicationData getVocabularyApplicationData()
void reset()
void setOutputStream(java.io.OutputStream s)
s
- the OutputStream where the fast infoset document is written to.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |