Package org.apache.jackrabbit.vault.util

Class DocViewNode2

java.lang.Object

org.apache.jackrabbit.vault.util.DocViewNode2

public class DocViewNode2
extends Object

Helper class that represents an immutable JCR node abstraction encapsulating multiple DocViewProperty2 properties.

Since:

3.6.0

See Also:

FileVault Document View Format

Constructor Summary

Constructors

Constructor	Description
DocViewNode2(@NotNull Name name, int index, @NotNull Collection<DocViewProperty2> properties)
DocViewNode2(@NotNull Name name, @NotNull Collection<DocViewProperty2> properties)

Method Summary

Modifier and Type	Method	Description
@NotNull DocViewNode2	cloneWithDifferentProperties(@NotNull Collection<DocViewProperty2> properties)
boolean	equals(Object obj)
static @NotNull DocViewNode2	fromNode(@NotNull Node node, boolean isRoot, boolean useBinaryReferences)
static @NotNull DocViewNode2	fromNode(@NotNull Node node, boolean isRoot, @NotNull Iterable<Property> properties, boolean useBinaryReferences)
@NotNull Optional<String>	getIdentifier()
int	getIndex()
@NotNull Collection<String>	getMixinTypes()
@NotNull Name	getName()
@NotNull Optional<String>	getPrimaryType()
@NotNull Collection<DocViewProperty2>	getProperties()
@NotNull Optional<DocViewProperty2>	getProperty(Name name)
@NotNull Optional<String>	getPropertyValue(@NotNull Name name)
@NotNull Collection<String>	getPropertyValues(@NotNull Name name)
@NotNull Name	getSnsAwareName()
int	hashCode()
boolean	hasProperty(Name name)
String	toString()
static void	writeEnd(@NotNull XMLStreamWriter writer)	Writes the node's end tag to the given XMLStreamWriter.
void	writeStart(@NotNull XMLStreamWriter writer, @NotNull NamespaceResolver nsResolver, @NotNull Iterable<String> namespacePrefixes)	Writes the node's start tag (including the attributes for the properties and optionally the namespace declarations) to the given XMLStreamWriter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocViewNode2

public DocViewNode2(@NotNull
                    @NotNull Name name,
                    @NotNull
                    @NotNull Collection<DocViewProperty2> properties)

DocViewNode2

public DocViewNode2(@NotNull
                    @NotNull Name name,
                    int index,
                    @NotNull
                    @NotNull Collection<DocViewProperty2> properties)

Method Detail

cloneWithDifferentProperties

@NotNull
public @NotNull DocViewNode2 cloneWithDifferentProperties(@NotNull
                                                          @NotNull Collection<DocViewProperty2> properties)

fromNode

@NotNull
public static @NotNull DocViewNode2 fromNode(@NotNull
                                             @NotNull Node node,
                                             boolean isRoot,
                                             boolean useBinaryReferences)
                                      throws RepositoryException

Throws:

RepositoryException

fromNode

@NotNull
public static @NotNull DocViewNode2 fromNode(@NotNull
                                             @NotNull Node node,
                                             boolean isRoot,
                                             @NotNull
                                             @NotNull Iterable<Property> properties,
                                             boolean useBinaryReferences)
                                      throws RepositoryException

Throws:

RepositoryException

getName

@NotNull
public @NotNull Name getName()

Returns:

the name of the Node represented by this class

getIndex

public int getIndex()

Returns:

0, except if there is a same-name sibling in the docview. In that case the index gives the 1-based order of the SNS nodes.

See Also:

Same-Name Siblings

getSnsAwareName

@NotNull
public @NotNull Name getSnsAwareName()

Returns:

the name suffixed by an index as outlined in Addressing Same-Name Siblings by Path in case there is a same-name sibling, otherwise the same value as for getName().

getProperties

@NotNull
public @NotNull Collection<DocViewProperty2> getProperties()

Returns:

all direct properties of the node represented by this object

getProperty

@NotNull
public @NotNull Optional<DocViewProperty2> getProperty(Name name)

hasProperty

public boolean hasProperty(Name name)

getPropertyValues

@NotNull
public @NotNull Collection<String> getPropertyValues(@NotNull
                                                     @NotNull Name name)

getPropertyValue

@NotNull
public @NotNull Optional<String> getPropertyValue(@NotNull
                                                  @NotNull Name name)

getPrimaryType

@NotNull
public @NotNull Optional<String> getPrimaryType()

getMixinTypes

@NotNull
public @NotNull Collection<String> getMixinTypes()

getIdentifier

@NotNull
public @NotNull Optional<String> getIdentifier()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

writeStart

public void writeStart(@NotNull
                       @NotNull XMLStreamWriter writer,
                       @NotNull
                       @NotNull NamespaceResolver nsResolver,
                       @NotNull
                       @NotNull Iterable<String> namespacePrefixes)
                throws NamespaceException,
                       XMLStreamException

Writes the node's start tag (including the attributes for the properties and optionally the namespace declarations) to the given XMLStreamWriter. Use the following writer for properly formatting the output according to FileVault standards: FormattingXmlStreamWriter.create(out, new DocViewFormat().getXmlOutputFormat()).

Parameters:

writer - the XMLStreamWriter to write to

nsResolver - the namespace resolver to use for retrieving prefixes for namespace URIs of getName() and DocViewProperty2.getName()

namespacePrefixes - the namespace prefixes for which to emit namespace declarations in this node

Throws:

NamespaceException - in case no prefix is defined for the namespace URI of a name (either node's or property's)

XMLStreamException

Since:

3.6.2

writeEnd

public static void writeEnd(@NotNull
                            @NotNull XMLStreamWriter writer)
                     throws XMLStreamException

Writes the node's end tag to the given XMLStreamWriter. Use the following writer for properly formatting the output according to FileVault standards: FormattingXmlStreamWriter.create(out, new DocViewFormat().getXmlOutputFormat()).

Parameters:

writer - the XMLStreamWriter to write to

Throws:

XMLStreamException

Since:

3.6.2