org.girod.jgraphml.model

Interface IDElement

All Known Subinterfaces:

IGraphMLNode, IGraphMLTemplate, LabeledElement

All Known Implementing Classes:

AbstractGraphMLNode, AbstractIDElement, GraphMLEdge, GraphMLEdgeTemplate, GraphMLGroupNode, GraphMLGroupNodeTemplate, GraphMLNode, GraphMLNodeTemplate

public interface IDElement

Reprtesrnts an element which has an ID.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Return the element description.
java.lang.String	getID() Returns the element id.
java.net.URL	getURL() Return the URL of the element.
java.lang.String	getURLAsString(java.net.URL baseURL) Return the element associated URL as a String.
default boolean	hasDescription() Return true if the element has a description.
boolean	hasURL() Return true if the element has an associated URL.
default boolean	isTemplate() Return true if this element is a template.
void	setDescription(java.lang.String desc) Set the element description.
default void	setURL(java.io.File file) Sets the element associated file.
void	setURL(java.net.URL url) Sets the element associated URL.

Method Detail

getID

java.lang.String getID()

Returns the element id.

Returns:

the element id

setURL

default void setURL(java.io.File file)

Sets the element associated file.

Parameters:

file - the file

setURL

void setURL(java.net.URL url)

Sets the element associated URL.

Parameters:

url - the URL

hasURL

boolean hasURL()

Return true if the element has an associated URL.

Returns:

true if the element has an associated URL

getURLAsString

java.lang.String getURLAsString(java.net.URL baseURL)

Return the element associated URL as a String.

Parameters:

baseURL - the base URL

Returns:

the element associated URL as a String

getURL

java.net.URL getURL()

Return the URL of the element. The URL allows to specify a hyperlink for the element.

Returns:

the URL

setDescription

void setDescription(java.lang.String desc)

Set the element description.

Parameters:

desc - the description

getDescription

java.lang.String getDescription()

Return the element description.

Returns:

the description

hasDescription

default boolean hasDescription()

Return true if the element has a description.

Returns:

true if the element has a description

isTemplate

default boolean isTemplate()

Return true if this element is a template. Return false by default.

Returns:

true if this element is a template