Class DefaultBrowseGraphic

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultBrowseGraphic

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Browse­Graphic

@TitleProperty(name="fileName")
public class DefaultBrowseGraphic
extends ISOMetadata
implements BrowseGraphic

Graphic that provides an illustration of the dataset (should include a legend for the graphic). The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Browse­Graphic └─file­Name………… Name of the file that contains a graphic that provides an illustration of the dataset.

Limitations

• Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
• Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Browse­Graphic()	Constructs an initially empty browse graphic.
Default­Browse­Graphic(URI file­Name)	Creates a browse graphics initialized to the specified URI.
Default­Browse­Graphic(Browse­Graphic object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Browse­Graphic	cast­Or­Copy(Browse­Graphic object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­File­Description()	Returns the text description of the illustration.
URI	get­File­Name()	Returns the name of the file that contains a graphic that provides an illustration of the dataset.
String	get­File­Type()	Format in which the illustration is encoded.
Collection<Constraints>	get­Image­Constraints()	Returns the restrictions on access and / or use of browse graphic.
Collection<Online­Resource>	get­Linkages()	Return the links to browse graphic.
void	set­File­Description(International­String new­Value)	Sets the text description of the illustration.
void	set­File­Name(URI new­Value)	Sets the name of the file that contains a graphic that provides an illustration of the dataset.
void	set­File­Type(String new­Value)	Sets the format in which the illustration is encoded.
void	set­Image­Constraints(Collection<? extends Constraints> new­Values)	Sets the restrictions on access and / or use of browse graphic.
void	set­Linkages(Collection<? extends Online­Resource> new­Values)	Sets the links to browse graphic.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultBrowseGraphic

public DefaultBrowseGraphic()

Constructs an initially empty browse graphic.

DefaultBrowseGraphic

public DefaultBrowseGraphic(URI fileName)

Creates a browse graphics initialized to the specified URI.

Parameters:

file­Name - the name of the file that contains a graphic.

DefaultBrowseGraphic

public DefaultBrowseGraphic(BrowseGraphic object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

• cast­Or­Copy(Browse­Graphic)

Method Details

castOrCopy

public static DefaultBrowseGraphic castOrCopy(BrowseGraphic object)

Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Browse­Graphic, then it is returned unchanged.
• Otherwise a new Default­Browse­Graphic instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

getFileName

public URI getFileName()

Returns the name of the file that contains a graphic that provides an illustration of the dataset.

Specified by:

get­File­Name in interface Browse­Graphic

Returns:

file that contains a graphic that provides an illustration of the dataset, or null.

setFileName

public void setFileName(URI newValue)

Sets the name of the file that contains a graphic that provides an illustration of the dataset.

Parameters:

new­Value - the new filename.

getFileDescription

public InternationalString getFileDescription()

Returns the text description of the illustration.

Specified by:

get­File­Description in interface Browse­Graphic

Returns:

text description of the illustration, or null.

setFileDescription

public void setFileDescription(InternationalString newValue)

Sets the text description of the illustration.

Parameters:

new­Value - the new file description.

getFileType

public String getFileType()

Format in which the illustration is encoded.

Examples

CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.

Specified by:

get­File­Type in interface Browse­Graphic

Returns:

format in which the illustration is encoded, or null.

See Also:

• Image­IO.get­Reader­Format­Names()

setFileType

public void setFileType(String newValue)

Sets the format in which the illustration is encoded. Raster formats are encouraged to use one of the names returned by Image­IO.get­Reader­Format­Names().

Parameters:

new­Value - the new file type.

getImageConstraints

@UML(identifier="imageContraints",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Constraints> getImageConstraints()

Returns the restrictions on access and / or use of browse graphic.

Returns:

restrictions on access and / or use of browse graphic.

Since:

0.5

setImageConstraints

public void setImageConstraints(Collection<? extends Constraints> newValues)

Sets the restrictions on access and / or use of browse graphic.

Parameters:

new­Values - the new restrictions on access and / or use of browse graphic.

Since:

0.5

getLinkages

@UML(identifier="linkage",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<OnlineResource> getLinkages()

Return the links to browse graphic.

Returns:

the links to browse graphic.

Since:

0.5

setLinkages

public void setLinkages(Collection<? extends OnlineResource> newValues)

Sets the links to browse graphic.

Parameters:

new­Values - the new links to browse graphic.

Since:

0.5