Package com.adobe.epubcheck.opf

Class MetadataSet

java.lang.Object

com.adobe.epubcheck.opf.MetadataSet

public final class MetadataSet
extends java.lang.Object

Represents a set of metadata as declared in the metadata element in an EPUB Publication document (OPF).

The graph of refines is resolved when building the metadata set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataSet.Builder	A builder for sets of metadata expressions.
static class	MetadataSet.Metadata	Represents a metadata expression.

Field Summary

Fields

Modifier and Type	Field	Description
private com.google.common.collect.SetMultimap<Property,MetadataSet.Metadata>	all
private com.google.common.base.Supplier<java.util.Set<MetadataSet.Metadata>>	allSet
private com.google.common.collect.SetMultimap<Property,MetadataSet.Metadata>	primary
private com.google.common.base.Supplier<java.util.Set<MetadataSet.Metadata>>	primarySet
private com.google.common.collect.SetMultimap<java.lang.String,MetadataSet.Metadata>	refiners
private java.util.Map<MetadataSet.Metadata,MetadataSet.Metadata>	refines

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MetadataSet(com.google.common.collect.Multimap<Property,MetadataSet.Metadata> all, com.google.common.collect.Multimap<Property,MetadataSet.Metadata> primary, java.util.Map<MetadataSet.Metadata,MetadataSet.Metadata> refines, com.google.common.collect.Multimap<java.lang.String,MetadataSet.Metadata> refiners)

Method Summary

Modifier and Type	Method	Description
static MetadataSet.Builder	builder()	Creates a new builder.
boolean	containsAny(Property property)	Returns true if this metadata set contains an expression (primary or subexpression) for the given property
boolean	containsPrimary(Property property)	Returns true if this metadata set contains a primary expression for the given property
boolean	containsPrimary(Property property, java.lang.String value)	Returns true if this metadata set contains a primary expression for the given property and the given value
java.util.Set<MetadataSet.Metadata>	getAll()	Returns a set of all metadata expressions (primary+subexpressions).
java.util.Set<MetadataSet.Metadata>	getAny(Property property)	Returns the set of all metadata expressions (primary and subexpressions) for the given property.
java.util.Set<MetadataSet.Metadata>	getPrimary()	Returns a set of all primary metadata expressions.
java.util.Set<MetadataSet.Metadata>	getPrimary(Property property)	Returns the set of metadata primary expressions for the given property.
com.google.common.base.Optional<MetadataSet.Metadata>	getRefinedBy(MetadataSet.Metadata meta)	Returns an optional metadata expression refined by the given metadata expression.
java.util.Set<MetadataSet.Metadata>	getRefining(java.lang.String id)	Returns the set of all metadata subexpressions refining the metadata or resource identified by the given ID.
static com.google.common.base.Optional<MetadataSet.Metadata>	tryFind(java.util.Set<MetadataSet.Metadata> metas, Property property, com.google.common.base.Optional<java.lang.String> value)	Search all the given expressions and return the first one that matches the given property and value (if present).
static com.google.common.base.Optional<MetadataSet.Metadata>	tryFindInRefines(java.util.Set<MetadataSet.Metadata> metas, Property property, com.google.common.base.Optional<java.lang.String> value)	Search all refining expressions of the given metadata expressions, and return the first one that matches the given property and value (if present).

Methods inherited from class java.lang.Object

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

Field Detail

all

private final com.google.common.collect.SetMultimap<Property,MetadataSet.Metadata> all

primary

private final com.google.common.collect.SetMultimap<Property,MetadataSet.Metadata> primary

refiners

private final com.google.common.collect.SetMultimap<java.lang.String,MetadataSet.Metadata> refiners

refines

private final java.util.Map<MetadataSet.Metadata,MetadataSet.Metadata> refines

allSet

private final com.google.common.base.Supplier<java.util.Set<MetadataSet.Metadata>> allSet

primarySet

private final com.google.common.base.Supplier<java.util.Set<MetadataSet.Metadata>> primarySet

Constructor Detail

MetadataSet

private MetadataSet(com.google.common.collect.Multimap<Property,MetadataSet.Metadata> all,
                    com.google.common.collect.Multimap<Property,MetadataSet.Metadata> primary,
                    java.util.Map<MetadataSet.Metadata,MetadataSet.Metadata> refines,
                    com.google.common.collect.Multimap<java.lang.String,MetadataSet.Metadata> refiners)

Method Detail

getPrimary

public java.util.Set<MetadataSet.Metadata> getPrimary()

Returns a set of all primary metadata expressions.

Returns:

an immutable set (possibly empty) of all primary metadata expressions.

getAll

public java.util.Set<MetadataSet.Metadata> getAll()

Returns a set of all metadata expressions (primary+subexpressions).

Returns:

an immutable set (possibly empty) of all metadata expressions.

containsPrimary

public boolean containsPrimary(Property property)

Returns true if this metadata set contains a primary expression for the given property

Parameters:

property - a property from a metadata vocabulary

Returns:

true if this metadata set contains a primary expression for the given property

containsPrimary

public boolean containsPrimary(Property property,
                               java.lang.String value)

Returns true if this metadata set contains a primary expression for the given property and the given value

Parameters:

property - a property from a metadata vocabulary

value - the value to search

Returns:

true if this metadata set contains a primary expression for the given property and value

containsAny

public boolean containsAny(Property property)

Returns true if this metadata set contains an expression (primary or subexpression) for the given property

Parameters:

property - a property from a metadata vocabulary

Returns:

true if this metadata set contains an expression for the given property

getPrimary

public java.util.Set<MetadataSet.Metadata> getPrimary(Property property)

Returns the set of metadata primary expressions for the given property.

Parameters:

property - a property from a metadata vocabulary

Returns:

the set of metadata primary expressions for the given property, or an empty set if none exist.

getAny

public java.util.Set<MetadataSet.Metadata> getAny(Property property)

Returns the set of all metadata expressions (primary and subexpressions) for the given property.

Parameters:

property - a property from a metadata vocabulary

Returns:

the set of all metadata expressions for the given property, or an empty set if none exist.

getRefinedBy

public com.google.common.base.Optional<MetadataSet.Metadata> getRefinedBy(MetadataSet.Metadata meta)

Returns an optional metadata expression refined by the given metadata expression.

Parameters:

meta - a metadata expression

Returns:

Optional.absent() if the given metadata expression does not refine another metadata expression or a Optional#of(Metadata) containing the refined metadata expression

getRefining

public java.util.Set<MetadataSet.Metadata> getRefining(java.lang.String id)

Returns the set of all metadata subexpressions refining the metadata or resource identified by the given ID.

Parameters:

id - a string ID

Returns:

the set of all metadata subexpressions refining the given ID, or an empty set if none exist.

tryFindInRefines

public static com.google.common.base.Optional<MetadataSet.Metadata> tryFindInRefines(java.util.Set<MetadataSet.Metadata> metas,
                                                                                     Property property,
                                                                                     com.google.common.base.Optional<java.lang.String> value)

Search all refining expressions of the given metadata expressions, and return the first one that matches the given property and value (if present).

If value is Optional.absent()

, only the property is used in the lookup.

Parameters:

metas - A set of metadata expressions to search

property - The property of the searched expression

value - The value of the searched expression, can be absent if the value is not relevant in the search

Returns:

an Optional containing an expression refining one of the expressions in metas and matching the given property and value, or Optional.absent() if none is found.

tryFind

public static com.google.common.base.Optional<MetadataSet.Metadata> tryFind(java.util.Set<MetadataSet.Metadata> metas,
                                                                            Property property,
                                                                            com.google.common.base.Optional<java.lang.String> value)

Search all the given expressions and return the first one that matches the given property and value (if present).

If value is Optional.absent()

, only the property is used in the lookup.

Parameters:

metas - A set of metadata expressions to search

property - The property of the searched expression

value - The value of the searched expression, can be absent if the value is not relevant in the search

Returns:

an Optional containing an expression in the metas set matching the given property and value, or Optional.absent() if none is found.

builder

public static MetadataSet.Builder builder()

Creates a new builder. Calling this method is identical to calling the empty MetadataSet.Builder constructor.

Returns:

a newly created builder.