Package org.ivoa.dm.executionbroker

Class JupyterNotebook

java.lang.Object

org.ivoa.dm.executionbroker.AbstractComponent

org.ivoa.dm.executionbroker.AbstractExecutable

org.ivoa.dm.executionbroker.JupyterNotebook

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="execbroker:JupyterNotebook",
       role=objectType)
public class JupyterNotebook
extends AbstractExecutable
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Details for a Jupyter notebook executable. See https://jupyter.org/. objectType: JupyterNotebook

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JupyterNotebook.JupyterNotebookBuilder	A builder class for JupyterNotebook, mainly for use in the functional builder pattern.

Nested classes/interfaces inherited from class org.ivoa.dm.executionbroker.AbstractExecutable

AbstractExecutable.AbstractExecutableBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	location	The URL of the notebook.

Fields inherited from class org.ivoa.dm.executionbroker.AbstractExecutable

lifecycle

Fields inherited from class org.ivoa.dm.executionbroker.AbstractComponent

_id, kind, meta

Constructor Summary

Constructors

Constructor	Description
JupyterNotebook()	Creates a new JupyterNotebook
JupyterNotebook(String location, LifecycleComponent lifecycle, String kind, ComponentMetadata meta)	full parameter constructor.
JupyterNotebook(AbstractExecutable superinstance, String location)	Constructor from supertype instance.
JupyterNotebook(JupyterNotebook other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
AbstractComponent	copyMe()	make a clone of the object taking into account current polymorhic type.
static JupyterNotebook	createJupyterNotebook(Consumer<JupyterNotebook.JupyterNotebookBuilder> f)	create a JupyterNotebook in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
String	getLocation()	Returns location Attribute.
void	setLocation(String pLocation)	Set location Attribute.
void	updateUsing(JupyterNotebook other)	Update this object with the content of the given object.
JupyterNotebook	withLocation(String pLocation)	fluent setter for location Attribute.

Methods inherited from class org.ivoa.dm.executionbroker.AbstractExecutable

createAbstractExecutable, getLifecycle, setLifecycle, updateUsing, withLifecycle

Methods inherited from class org.ivoa.dm.executionbroker.AbstractComponent

getId, getKind, getMeta, setKind, setMeta, updateUsing, withKind, withMeta

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

getId

Field Details

location

@VoDml(id="execbroker:JupyterNotebook.location",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String location

The URL of the notebook. TODO - This needs to take into account different ways of referring to a notebook. : Attribute location : multiplicity 1

Constructor Details

JupyterNotebook

public JupyterNotebook()

Creates a new JupyterNotebook

JupyterNotebook

public JupyterNotebook(String location,
 LifecycleComponent lifecycle,
 String kind,
 ComponentMetadata meta)

full parameter constructor.

Parameters:

location - The URL of the notebook. TODO - This needs to take into account different ways of referring to a notebook.

lifecycle - .

kind - The component type identifier.

meta - The component metadata.

JupyterNotebook

public JupyterNotebook(JupyterNotebook other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

JupyterNotebook

public JupyterNotebook(AbstractExecutable superinstance,
 String location)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

location - The URL of the notebook. TODO - This needs to take into account different ways of referring to a notebook.

Method Details

copyMe

public AbstractComponent copyMe()

make a clone of the object taking into account current polymorhic type.

Overrides:

copyMe in class AbstractExecutable

Returns:

the cloned object.

updateUsing

public void updateUsing(JupyterNotebook other)

Update this object with the content of the given object. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

getLocation

public String getLocation()

Returns location Attribute.

Returns:

location Attribute

setLocation

public void setLocation(String pLocation)

Set location Attribute.

Parameters:

pLocation - value to set

withLocation

public JupyterNotebook withLocation(String pLocation)

fluent setter for location Attribute.

Parameters:

pLocation - value to set

Returns:

JupyterNotebook

createJupyterNotebook

public static JupyterNotebook createJupyterNotebook(Consumer<JupyterNotebook.JupyterNotebookBuilder> f)

create a JupyterNotebook in functional builder style.

Parameters:

f - the functional builder.

Returns:

an object initialized from the builder.

forceLoad

public void forceLoad()

Specified by:

forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

Overrides:

forceLoad in class AbstractExecutable

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Overrides:

delete in class AbstractExecutable