org.digitalmediaserver.cast

Class Metadata

java.lang.Object

org.digitalmediaserver.cast.Metadata

public class Metadata
extends Object

A utility class for working with "cast metadata" with defined constants and methods for converting dates.

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.AudiobookChapter The standard metadata keys defined for "Audiobook chapter" media.
static class	Metadata.Generic The standard metadata keys defined for "Generic" media.
static class	Metadata.MetadataType Describes the type of the data found inside the metadata.
static class	Metadata.Movie The standard metadata keys defined for "Movie" media.
static class	Metadata.MusicTrack The standard metadata keys defined for "Music track" media.
static class	Metadata.Photo The standard metadata keys defined for "Photo" media.
static class	Metadata.TvShow The standard metadata keys defined for "TV show" media.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DATE_TIME_PATTERN The format pattern to use when converting to string
static String	IMAGES The key used for metadata images
static String	METADATA_TYPE The key used for Metadata.MetadataType
protected static String[]	TIME_ZONE_PATTERNS An array of the supported time zone patterns

Method Summary

Modifier and Type	Method and Description
static String	dateToString(Calendar calendar) Converts a Calendar instance to a "metadata date" formatted string.
protected static String	extractDate(String dateTimeString) Extracts the "date part" of the date and time string.
static List<Image>	extractImages(Map<String,Object> metadata) Utility method to extract Images from metadata stored as a Map.
protected static String	extractTime(String dateTimeString) Extracts the "time part" of the date and time string.
static Calendar	parseDate(String dateTimeString) Attempts to parse a date and time string formatted as a "metadata date" to a Calendar instance.
static boolean	setImages(Map<String,Object> metadata, Collection<Image> images) Utility method to "set" (insert or replace) the Images of metadata stored as a Map.
static boolean	setImages(Map<String,Object> metadata, Image... images) Utility method to "set" (insert or replace) the Images of metadata stored as a Map.

Methods inherited from class java.lang.Object

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

Field Detail

TIME_ZONE_PATTERNS

protected static final String[] TIME_ZONE_PATTERNS

An array of the supported time zone patterns

DATE_TIME_PATTERN

protected static final String DATE_TIME_PATTERN

The format pattern to use when converting to string

See Also:

Constant Field Values

METADATA_TYPE

public static final String METADATA_TYPE

The key used for Metadata.MetadataType

See Also:

Constant Field Values

IMAGES

public static final String IMAGES

The key used for metadata images

See Also:

Constant Field Values

Method Detail

extractImages

@Nonnull
public static List<Image> extractImages(@Nullable
                                                  Map<String,Object> metadata)

Utility method to extract Images from metadata stored as a Map.

Parameters:

metadata - the metadata to extract from.

Returns:

The resulting List of Images.

setImages

public static boolean setImages(@Nullable
                                Map<String,Object> metadata,
                                Image... images)

Utility method to "set" (insert or replace) the Images of metadata stored as a Map.

Parameters:

metadata - to metadata to alter.

images - the Image(s) to set.

Returns:

true if the metadata was altered, false if it wasn't.

setImages

public static boolean setImages(@Nullable
                                Map<String,Object> metadata,
                                @Nullable
                                Collection<Image> images)

Utility method to "set" (insert or replace) the Images of metadata stored as a Map.

Parameters:

metadata - to metadata to alter.

images - the Collection of Images to set.

Returns:

true if the metadata was altered, false if it wasn't.

dateToString

@Nullable
public static String dateToString(Calendar calendar)

Converts a Calendar instance to a "metadata date" formatted string.

Parameters:

calendar - the Calendar instance to convert.

Returns:

The resulting string or null if calendar is null.

parseDate

@Nullable
public static Calendar parseDate(String dateTimeString)

Attempts to parse a date and time string formatted as a "metadata date" to a Calendar instance.

Parameters:

dateTimeString - the date and time string to parse.

Returns:

The resulting Calendar or null.

extractDate

@Nullable
protected static String extractDate(String dateTimeString)

Extracts the "date part" of the date and time string.

Parameters:

dateTimeString - the date and time string to extract from.

Returns:

The "date part" string or null.

extractTime

@Nullable
protected static String extractTime(@Nullable
                                               String dateTimeString)

Extracts the "time part" of the date and time string.

Parameters:

dateTimeString - the date and time string to extract from.

Returns:

The "time part" string or null.