Package com.kazurayam.materialstore.core

Class Metadata

java.lang.Object

com.kazurayam.materialstore.core.Metadata

All Implemented Interfaces:

Jsonifiable, TemplateReady, Comparable<Metadata>

Direct Known Subclasses:

MetadataImpl

public abstract class Metadata
extends Object
implements Comparable<Metadata>, Jsonifiable, TemplateReady

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metadata.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_URL_FRAGMENT
static final String	KEY_URL_HOST
static final String	KEY_URL_PATH
static final String	KEY_URL_PORT
static final String	KEY_URL_PROTOCOL
static final String	KEY_URL_QUERY
static final Metadata	NULL_OBJECT

Constructor Summary

Constructors

Constructor	Description
Metadata()

Method Summary

Modifier and Type	Method	Description
abstract void	annotate(QueryOnMetadata query)
abstract void	annotate(QueryOnMetadata query, IgnoreMetadataKeys ignoreMetadataKeys, IdentifyMetadataValues identifyMetadataValues)
static Metadata.Builder	builder()
static Metadata.Builder	builder(Metadata source)
static Metadata.Builder	builder(URL url)
static Metadata.Builder	builder(Map<String,String> map)
abstract boolean	canBeIdentified(String key, IdentifyMetadataValues identifyMetadataValues)
abstract boolean	canBePaired(QueryOnMetadata query, String key)
abstract int	compareTo(Metadata other)
abstract boolean	containsCategoryDiff()
abstract boolean	containsKey(String key)
abstract String	get(String key)
abstract MaterialLocator	getMaterialLocatorLeft()
abstract MaterialLocator	getMaterialLocatorRight()
abstract MetadataAttribute	getMetadataAttribute(String key)
abstract MetadataIdentification	getMetadataIdentification()
abstract MetadataIdentification	getMetadataIdentification(SortKeys sortKeys)
abstract boolean	isEmpty()
abstract Set<String>	keySet()
abstract boolean	matchesByAster(QueryOnMetadata query, String key)
abstract boolean	matchesIndividually(QueryOnMetadata query, String key)
static List<KeyValuePair>	parseQuery(String query)
abstract int	size()
abstract URL	toURL()
abstract String	toURLAsString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kazurayam.materialstore.core.Jsonifiable

toJson, toJson

Methods inherited from interface com.kazurayam.materialstore.core.TemplateReady

toTemplateModel, toTemplateModelAsJson, toTemplateModelAsJson

Field Details

NULL_OBJECT

public static final Metadata NULL_OBJECT

KEY_URL_PROTOCOL

public static final String KEY_URL_PROTOCOL

See Also:

• Constant Field Values

KEY_URL_PORT

public static final String KEY_URL_PORT

See Also:

• Constant Field Values

KEY_URL_HOST

public static final String KEY_URL_HOST

See Also:

• Constant Field Values

KEY_URL_PATH

public static final String KEY_URL_PATH

See Also:

• Constant Field Values

KEY_URL_QUERY

public static final String KEY_URL_QUERY

See Also:

• Constant Field Values

KEY_URL_FRAGMENT

public static final String KEY_URL_FRAGMENT

See Also:

• Constant Field Values

Constructor Details

Metadata

public Metadata()

Method Details

annotate

public abstract void annotate(QueryOnMetadata query)

annotate

public abstract void annotate(QueryOnMetadata query,
 IgnoreMetadataKeys ignoreMetadataKeys,
 IdentifyMetadataValues identifyMetadataValues)

canBeIdentified

public abstract boolean canBeIdentified(String key,
 IdentifyMetadataValues identifyMetadataValues)

canBePaired

public abstract boolean canBePaired(QueryOnMetadata query,
 String key)

containsKey

public abstract boolean containsKey(String key)

containsCategoryDiff

public abstract boolean containsCategoryDiff()

get

public abstract String get(String key)

getMaterialLocatorLeft

public abstract MaterialLocator getMaterialLocatorLeft()

getMaterialLocatorRight

public abstract MaterialLocator getMaterialLocatorRight()

getMetadataIdentification

public abstract MetadataIdentification getMetadataIdentification()

getMetadataIdentification

public abstract MetadataIdentification getMetadataIdentification(SortKeys sortKeys)

getMetadataAttribute

public abstract MetadataAttribute getMetadataAttribute(String key)

isEmpty

public abstract boolean isEmpty()

keySet

public abstract Set<String> keySet()

matchesByAster

public abstract boolean matchesByAster(QueryOnMetadata query,
 String key)

matchesIndividually

public abstract boolean matchesIndividually(QueryOnMetadata query,
 String key)

size

public abstract int size()

toURLAsString

public abstract String toURLAsString()
                              throws MaterialstoreException

Throws:

MaterialstoreException

toURL

public abstract URL toURL()
                   throws MaterialstoreException

Throws:

MaterialstoreException

compareTo

public abstract int compareTo(Metadata other)

Specified by:

compareTo in interface Comparable<Metadata>

builder

public static Metadata.Builder builder()

builder

public static Metadata.Builder builder(Metadata source)

builder

public static Metadata.Builder builder(URL url)

builder

public static Metadata.Builder builder(Map<String,String> map)

parseQuery

public static List<KeyValuePair> parseQuery(String query)