Package com.io7m.laurel.filemodel.internal

Class LFileModel

java.lang.Object

com.io7m.laurel.filemodel.internal.LFileModel

All Implemented Interfaces:

LFileModelType, AutoCloseable

public final class LFileModel
extends Object
implements LFileModelType

The file model.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<?>	captionAdd(LCaptionName text)	Add a caption.
com.io7m.jattribute.core.AttributeReadableType<Set<LCaptionID>>	captionClipboard()
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	captionList()
CompletableFuture<?>	captionModify(LCaptionID id, LCaptionName name)	Modify a caption.
CompletableFuture<?>	captionRemove(Set<LCaptionID> captions)	Delete captions.
void	captionsCopy(Set<LCaptionID> captions)	Move a set of captions to the clipboard.
CompletableFuture<?>	captionsPaste(Set<LImageID> images)	Assign the captions in the clipboard to each of the given images, and then clear the clipboard.
void	captionsUnassignedListFilterSet(String filter)	Set the filter for the caption list.
com.io7m.jattribute.core.AttributeReadableType<List<LCategory>>	categoriesRequired()
CompletableFuture<?>	categoryAdd(LCategoryName text)	Add a category.
com.io7m.jattribute.core.AttributeReadableType<SortedMap<LCategoryID,List<LCaption>>>	categoryCaptions()
CompletableFuture<?>	categoryCaptionsAssign(List<LCategoryCaptionsAssignment> categories)	Assign the given captions to the given categories.
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	categoryCaptionsAssigned()
CompletableFuture<?>	categoryCaptionsUnassign(List<LCategoryCaptionsAssignment> categories)	Unassign the given captions from the given categories.
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	categoryCaptionsUnassigned()
com.io7m.jattribute.core.AttributeReadableType<List<LCategory>>	categoryList()
CompletableFuture<?>	categorySelect(Optional<LCategoryID> id)	Select a category.
com.io7m.jattribute.core.AttributeReadableType<Optional<LCategory>>	categorySelected()
CompletableFuture<?>	categorySetNotRequired(Set<LCategoryID> categories)	Set categories as not required.
CompletableFuture<?>	categorySetRequired(Set<LCategoryID> categories)	Set categories as required.
void	close()
CompletableFuture<?>	compact()	Compact the file, deleting the undo/redo log and cleaning up any unused data in the file.
SubmissionPublisher<LFileModelEventType>	events()
CompletableFuture<?>	export(LExportRequest request)	Execute an export.
void	exportClear()	Clear the export events.
com.io7m.jattribute.core.AttributeReadableType<List<LFileModelEventType>>	exportEvents()
CompletableFuture<?>	globalCaptionAdd(LCaptionName text)	Add a global caption.
com.io7m.jattribute.core.AttributeReadableType<List<LGlobalCaption>>	globalCaptionList()
CompletableFuture<?>	globalCaptionModify(LCaptionID id, LCaptionName newName)	Change the text for a global caption.
CompletableFuture<?>	globalCaptionOrderLower(LCaptionID id)	Lower the order of the given caption (making it higher priority).
CompletableFuture<?>	globalCaptionOrderUpper(LCaptionID id)	Increase the order of the given caption (making it lower priority).
CompletableFuture<?>	globalCaptionRemove(LCaptionID id)	Remove a global caption.
CompletableFuture<?>	imageAdd(String name, Path file, Optional<URI> source)	Load an image and add it to the file.
CompletableFuture<?>	imageCaptionsAssign(List<LImageCaptionsAssignment> assignments)	Assign captions to an image.
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	imageCaptionsAssigned()
CompletableFuture<?>	imageCaptionsUnassign(List<LImageCaptionsAssignment> assignments)	Unassign captions from an image.
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	imageCaptionsUnassigned()
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	imageCaptionsUnassignedFiltered()
com.io7m.jattribute.core.AttributeReadableType<Optional<LImageComparison>>	imageComparison()
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	imageComparisonA()
com.io7m.jattribute.core.AttributeReadableType<List<LCaption>>	imageComparisonB()
com.io7m.jattribute.core.AttributeReadableType<List<LImageWithID>>	imageList()
com.io7m.jattribute.core.AttributeReadableType<List<LImageWithID>>	imageListFiltered()
void	imageListFilterSet(String filter)	Set the filter for the image list.
CompletableFuture<Void>	imagesCompare(LImageID imageA, LImageID imageB)	Compare captions on images.
CompletableFuture<?>	imagesDelete(List<LImageID> ids)	Delete images.
CompletableFuture<?>	imageSelect(Optional<LImageID> name)	Select an image.
com.io7m.jattribute.core.AttributeReadableType<Optional<LImageWithID>>	imageSelected()
CompletableFuture<?>	imageSourceSet(LImageID image, URI source)	Change the source of an image.
CompletableFuture<Optional<InputStream>>	imageStream(LImageID id)
CompletableFuture<?>	loading()
com.io7m.jattribute.core.AttributeReadableType<List<LMetadataValue>>	metadataList()
CompletableFuture<?>	metadataPut(List<LMetadataValue> values)	Add or update metadata.
CompletableFuture<?>	metadataRemove(List<LMetadataValue> values)	Remove metadata.
static LFileModelType	open(Path file, boolean readOnly)	Open a file model.
CompletableFuture<?>	redo()	Redo the operation on the top of the redo stack
com.io7m.jattribute.core.AttributeReadableType<List<LCommandRecord>>	redoStack()
com.io7m.jattribute.core.AttributeReadableType<Optional<String>>	redoText()
com.io7m.jattribute.core.AttributeReadableType<LFileModelStatusType>	status()
CompletableFuture<?>	undo()	Undo the operation on the top of the undo stack
com.io7m.jattribute.core.AttributeReadableType<List<LCommandRecord>>	undoStack()
com.io7m.jattribute.core.AttributeReadableType<Optional<String>>	undoText()
CompletableFuture<?>	validate()	Execute a validation.
com.io7m.jattribute.core.AttributeReadableType<List<LValidationProblemType>>	validationProblems()

Methods inherited from class java.lang.Object

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

Method Details

open

public static LFileModelType open(Path file,
 boolean readOnly)
                           throws LException

Open a file model.

Parameters:

file - The file

readOnly - true if the file should be read-only

Returns:

A file model

Throws:

LException - On errors

events

public SubmissionPublisher<LFileModelEventType> events()

Specified by:

events in interface LFileModelType

Returns:

The file model events

status

public com.io7m.jattribute.core.AttributeReadableType<LFileModelStatusType> status()

Specified by:

status in interface LFileModelType

Returns:

An observable status value for the file model

globalCaptionAdd

public CompletableFuture<?> globalCaptionAdd(LCaptionName text)

Description copied from interface: LFileModelType

Add a global caption.

Specified by:

globalCaptionAdd in interface LFileModelType

Parameters:

text - The caption

Returns:

The operation in progress

globalCaptionRemove

public CompletableFuture<?> globalCaptionRemove(LCaptionID id)

Description copied from interface: LFileModelType

Remove a global caption.

Specified by:

globalCaptionRemove in interface LFileModelType

Parameters:

id - The caption

Returns:

The operation in progress

globalCaptionOrderLower

public CompletableFuture<?> globalCaptionOrderLower(LCaptionID id)

Description copied from interface: LFileModelType

Lower the order of the given caption (making it higher priority).

Specified by:

globalCaptionOrderLower in interface LFileModelType

Parameters:

id - The caption

Returns:

The operation in progress

globalCaptionOrderUpper

public CompletableFuture<?> globalCaptionOrderUpper(LCaptionID id)

Description copied from interface: LFileModelType

Increase the order of the given caption (making it lower priority).

Specified by:

globalCaptionOrderUpper in interface LFileModelType

Parameters:

id - The caption

Returns:

The operation in progress

globalCaptionModify

public CompletableFuture<?> globalCaptionModify(LCaptionID id,
 LCaptionName newName)

Description copied from interface: LFileModelType

Change the text for a global caption.

Specified by:

globalCaptionModify in interface LFileModelType

Parameters:

id - The caption

newName - The new text

Returns:

The operation in progress

categoryAdd

public CompletableFuture<?> categoryAdd(LCategoryName text)

Description copied from interface: LFileModelType

Add a category.

Specified by:

categoryAdd in interface LFileModelType

Parameters:

text - The category

Returns:

The operation in progress

captionAdd

public CompletableFuture<?> captionAdd(LCaptionName text)

Description copied from interface: LFileModelType

Add a caption.

Specified by:

captionAdd in interface LFileModelType

Parameters:

text - The caption

Returns:

The operation in progress

captionModify

public CompletableFuture<?> captionModify(LCaptionID id,
 LCaptionName name)

Description copied from interface: LFileModelType

Modify a caption.

Specified by:

captionModify in interface LFileModelType

Parameters:

id - The caption ID

name - The caption text

Returns:

The operation in progress

captionRemove

public CompletableFuture<?> captionRemove(Set<LCaptionID> captions)

Description copied from interface: LFileModelType

Delete captions.

Specified by:

captionRemove in interface LFileModelType

Parameters:

captions - The captions

Returns:

The operation in progress

categorySetRequired

public CompletableFuture<?> categorySetRequired(Set<LCategoryID> categories)

Description copied from interface: LFileModelType

Set categories as required.

Specified by:

categorySetRequired in interface LFileModelType

Parameters:

categories - The categories

Returns:

The operation in progress

categorySetNotRequired

public CompletableFuture<?> categorySetNotRequired(Set<LCategoryID> categories)

Description copied from interface: LFileModelType

Set categories as not required.

Specified by:

categorySetNotRequired in interface LFileModelType

Parameters:

categories - The categories

Returns:

The operation in progress

imageAdd

public CompletableFuture<?> imageAdd(String name,
 Path file,
 Optional<URI> source)

Description copied from interface: LFileModelType

Load an image and add it to the file.

Specified by:

imageAdd in interface LFileModelType

Parameters:

name - The (unique) name

file - The file

source - The URI source, if any

Returns:

The operation in progress

imagesDelete

public CompletableFuture<?> imagesDelete(List<LImageID> ids)

Description copied from interface: LFileModelType

Delete images.

Specified by:

imagesDelete in interface LFileModelType

Parameters:

ids - The ids

Returns:

The operation in progress

imageCaptionsAssign

public CompletableFuture<?> imageCaptionsAssign(List<LImageCaptionsAssignment> assignments)

Description copied from interface: LFileModelType

Assign captions to an image.

Specified by:

imageCaptionsAssign in interface LFileModelType

Parameters:

assignments - The assignments

Returns:

The operation in progress

imageCaptionsUnassign

public CompletableFuture<?> imageCaptionsUnassign(List<LImageCaptionsAssignment> assignments)

Description copied from interface: LFileModelType

Unassign captions from an image.

Specified by:

imageCaptionsUnassign in interface LFileModelType

Parameters:

assignments - The assignments

Returns:

The operation in progress

imagesCompare

public CompletableFuture<Void> imagesCompare(LImageID imageA,
 LImageID imageB)

Description copied from interface: LFileModelType

Compare captions on images.

Specified by:

imagesCompare in interface LFileModelType

Parameters:

imageA - The left image

imageB - The right image

Returns:

The operation in progress

imageSelect

public CompletableFuture<?> imageSelect(Optional<LImageID> name)

Description copied from interface: LFileModelType

Select an image.

Specified by:

imageSelect in interface LFileModelType

Parameters:

name - The name

Returns:

The operation in progress

categoryCaptionsAssign

public CompletableFuture<?> categoryCaptionsAssign(List<LCategoryCaptionsAssignment> categories)

Description copied from interface: LFileModelType

Assign the given captions to the given categories.

Specified by:

categoryCaptionsAssign in interface LFileModelType

Parameters:

categories - The categories/captions

Returns:

The operation in progress

categoryCaptionsUnassign

public CompletableFuture<?> categoryCaptionsUnassign(List<LCategoryCaptionsAssignment> categories)

Description copied from interface: LFileModelType

Unassign the given captions from the given categories.

Specified by:

categoryCaptionsUnassign in interface LFileModelType

Parameters:

categories - The categories/captions

Returns:

The operation in progress

categorySelect

public CompletableFuture<?> categorySelect(Optional<LCategoryID> id)

Description copied from interface: LFileModelType

Select a category.

Specified by:

categorySelect in interface LFileModelType

Parameters:

id - The id

Returns:

The operation in progress

metadataPut

public CompletableFuture<?> metadataPut(List<LMetadataValue> values)

Description copied from interface: LFileModelType

Add or update metadata.

Specified by:

metadataPut in interface LFileModelType

Parameters:

values - The metadata values

Returns:

The operation in progress

metadataRemove

public CompletableFuture<?> metadataRemove(List<LMetadataValue> values)

Description copied from interface: LFileModelType

Remove metadata.

Specified by:

metadataRemove in interface LFileModelType

Parameters:

values - The metadata values

Returns:

The operation in progress

close

public void close()
           throws LException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LFileModelType

Throws:

LException

metadataList

public com.io7m.jattribute.core.AttributeReadableType<List<LMetadataValue>> metadataList()

Specified by:

metadataList in interface LFileModelType

Returns:

The current complete list of metadata

categorySelected

public com.io7m.jattribute.core.AttributeReadableType<Optional<LCategory>> categorySelected()

Specified by:

categorySelected in interface LFileModelType

Returns:

The currently selected category

imageSelected

public com.io7m.jattribute.core.AttributeReadableType<Optional<LImageWithID>> imageSelected()

Specified by:

imageSelected in interface LFileModelType

Returns:

The currently selected image

imageList

public com.io7m.jattribute.core.AttributeReadableType<List<LImageWithID>> imageList()

Specified by:

imageList in interface LFileModelType

Returns:

The current complete list of images

imageListFilterSet

public void imageListFilterSet(String filter)

Description copied from interface: LFileModelType

Set the filter for the image list.

Specified by:

imageListFilterSet in interface LFileModelType

Parameters:

filter - The filter

imageListFiltered

public com.io7m.jattribute.core.AttributeReadableType<List<LImageWithID>> imageListFiltered()

Specified by:

imageListFiltered in interface LFileModelType

Returns:

The current complete list of images with a search filter applied

categoriesRequired

public com.io7m.jattribute.core.AttributeReadableType<List<LCategory>> categoriesRequired()

Specified by:

categoriesRequired in interface LFileModelType

Returns:

The current complete list of required caption categories

captionList

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> captionList()

Specified by:

captionList in interface LFileModelType

Returns:

The current complete list of captions

imageCaptionsAssigned

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> imageCaptionsAssigned()

Specified by:

imageCaptionsAssigned in interface LFileModelType

Returns:

The list of captions assigned to the current image

imageCaptionsUnassigned

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> imageCaptionsUnassigned()

Specified by:

imageCaptionsUnassigned in interface LFileModelType

Returns:

The list of captions not assigned to the current image

imageCaptionsUnassignedFiltered

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> imageCaptionsUnassignedFiltered()

Specified by:

imageCaptionsUnassignedFiltered in interface LFileModelType

Returns:

The filtered list of captions not assigned to the current image

captionsUnassignedListFilterSet

public void captionsUnassignedListFilterSet(String filter)

Description copied from interface: LFileModelType

Set the filter for the caption list.

Specified by:

captionsUnassignedListFilterSet in interface LFileModelType

Parameters:

filter - The filter

undoText

public com.io7m.jattribute.core.AttributeReadableType<Optional<String>> undoText()

Specified by:

undoText in interface LFileModelType

Returns:

Text describing the top of the undo stack, if any

undoStack

public com.io7m.jattribute.core.AttributeReadableType<List<LCommandRecord>> undoStack()

Specified by:

undoStack in interface LFileModelType

Returns:

The undo stack

redoStack

public com.io7m.jattribute.core.AttributeReadableType<List<LCommandRecord>> redoStack()

Specified by:

redoStack in interface LFileModelType

Returns:

The redo stack

categoryCaptionsAssigned

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> categoryCaptionsAssigned()

Specified by:

categoryCaptionsAssigned in interface LFileModelType

Returns:

The list of captions assigned to the current category

categoryCaptionsUnassigned

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> categoryCaptionsUnassigned()

Specified by:

categoryCaptionsUnassigned in interface LFileModelType

Returns:

The list of captions not assigned to the current category

undo

public CompletableFuture<?> undo()

Description copied from interface: LFileModelType

Undo the operation on the top of the undo stack

Specified by:

undo in interface LFileModelType

Returns:

The operation in progress

redo

public CompletableFuture<?> redo()

Description copied from interface: LFileModelType

Redo the operation on the top of the redo stack

Specified by:

redo in interface LFileModelType

Returns:

The operation in progress

compact

public CompletableFuture<?> compact()

Description copied from interface: LFileModelType

Compact the file, deleting the undo/redo log and cleaning up any unused data in the file.

Specified by:

compact in interface LFileModelType

Returns:

The operation in progress

redoText

public com.io7m.jattribute.core.AttributeReadableType<Optional<String>> redoText()

Specified by:

redoText in interface LFileModelType

Returns:

Text describing the top of the redo stack, if any

categoryList

public com.io7m.jattribute.core.AttributeReadableType<List<LCategory>> categoryList()

Specified by:

categoryList in interface LFileModelType

Returns:

The current complete list of categories

categoryCaptions

public com.io7m.jattribute.core.AttributeReadableType<SortedMap<LCategoryID,List<LCaption>>> categoryCaptions()

Specified by:

categoryCaptions in interface LFileModelType

Returns:

The captions for every available category

imageStream

public CompletableFuture<Optional<InputStream>> imageStream(LImageID id)

Specified by:

imageStream in interface LFileModelType

Parameters:

id - The image ID

Returns:

The image data stream

globalCaptionList

public com.io7m.jattribute.core.AttributeReadableType<List<LGlobalCaption>> globalCaptionList()

Specified by:

globalCaptionList in interface LFileModelType

Returns:

The current complete list of global captions

imageComparisonA

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> imageComparisonA()

Specified by:

imageComparisonA in interface LFileModelType

Returns:

The list of captions that are on image A, but not on image B

imageComparisonB

public com.io7m.jattribute.core.AttributeReadableType<List<LCaption>> imageComparisonB()

Specified by:

imageComparisonB in interface LFileModelType

Returns:

The list of captions that are on image B, but not on image A

imageComparison

public com.io7m.jattribute.core.AttributeReadableType<Optional<LImageComparison>> imageComparison()

Specified by:

imageComparison in interface LFileModelType

Returns:

The current image comparison

captionClipboard

public com.io7m.jattribute.core.AttributeReadableType<Set<LCaptionID>> captionClipboard()

Specified by:

captionClipboard in interface LFileModelType

Returns:

The current caption clipboard

captionsCopy

public void captionsCopy(Set<LCaptionID> captions)

Description copied from interface: LFileModelType

Move a set of captions to the clipboard.

Specified by:

captionsCopy in interface LFileModelType

Parameters:

captions - The captions

captionsPaste

public CompletableFuture<?> captionsPaste(Set<LImageID> images)

Description copied from interface: LFileModelType

Assign the captions in the clipboard to each of the given images, and then clear the clipboard.

Specified by:

captionsPaste in interface LFileModelType

Parameters:

images - The images

Returns:

The operation in progress

validate

public CompletableFuture<?> validate()

Description copied from interface: LFileModelType

Execute a validation.

Specified by:

validate in interface LFileModelType

Returns:

The operation in progress

validationProblems

public com.io7m.jattribute.core.AttributeReadableType<List<LValidationProblemType>> validationProblems()

Specified by:

validationProblems in interface LFileModelType

Returns:

The list of validation problems

export

public CompletableFuture<?> export(LExportRequest request)

Description copied from interface: LFileModelType

Execute an export.

Specified by:

export in interface LFileModelType

Parameters:

request - The export request

Returns:

The operation in progress

exportEvents

public com.io7m.jattribute.core.AttributeReadableType<List<LFileModelEventType>> exportEvents()

Specified by:

exportEvents in interface LFileModelType

Returns:

The export events

exportClear

public void exportClear()

Description copied from interface: LFileModelType

Clear the export events.

Specified by:

exportClear in interface LFileModelType

imageSourceSet

public CompletableFuture<?> imageSourceSet(LImageID image,
 URI source)

Description copied from interface: LFileModelType

Change the source of an image.

Specified by:

imageSourceSet in interface LFileModelType

Parameters:

image - The image

source - The source

Returns:

The operation in progress

loading

public CompletableFuture<?> loading()

Specified by:

loading in interface LFileModelType

Returns:

A future that represents the file model's loading process