org.kuali.rice.kns.util.documentserializer
Class PropertySerializerTrie

java.lang.Object
  org.kuali.rice.kns.util.documentserializer.PropertySerializerTrie

public class PropertySerializerTrie
extends Object

This is a implementation of a trie/prefix tree of that contains metadata about property serializability during the document serialization process.

Field Summary

private static String	PROPERTY_NAME_COMPONENT_SEPARATOR
private PropertySerializerTrieNode	rootNode

Constructor Summary

PropertySerializerTrie()

Method Summary

void	addSerializablePropertyName(String propertyName, boolean setPropertySerializabilityToObjectAndAllPrimitivesForAll) Registers a new serializable property so that all of its primitives are serialized.
PropertySerializabilityMetadata	getPropertySerializabilityMetadata(String propertyName) Retrieves the metadata about the given property name
PropertySerializabilityMetadata	getRootPropertySerializibilityMetadata() Returns the root node of the trie
protected void	validateAttributeNameComponent(String attributeNameComponent)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_COMPONENT_SEPARATOR

private static final String PROPERTY_NAME_COMPONENT_SEPARATOR

See Also:

Constant Field Values

rootNode

private PropertySerializerTrieNode rootNode

Constructor Detail

PropertySerializerTrie

public PropertySerializerTrie()

Method Detail

addSerializablePropertyName

public void addSerializablePropertyName(String propertyName,
                                        boolean setPropertySerializabilityToObjectAndAllPrimitivesForAll)

Registers a new serializable property so that all of its primitives are serialized. All nesting properties will be serialized only to render open/close tags to maintain consistency with the document structure, unless they are registered as well. For example, if only property "document.a.b" is registered, then the XML will look like the following: <document> <a> <b> <primitiveOfB>valueOfPrimitive</primitiveOfB> </b> </a> </document> That is, primitives of "document" and "document.a" will not be serialized unless those property strings are registered.

Parameters:

propertyName -

setPropertySerializabilityToObjectAndAllPrimitivesForAll -

getPropertySerializabilityMetadata

public PropertySerializabilityMetadata getPropertySerializabilityMetadata(String propertyName)

Retrieves the metadata about the given property name

Parameters:

propertyName -

Returns:

getRootPropertySerializibilityMetadata

public PropertySerializabilityMetadata getRootPropertySerializibilityMetadata()

Returns the root node of the trie

Returns:

validateAttributeNameComponent

protected void validateAttributeNameComponent(String attributeNameComponent)