Package com.agisoft.metashape

Class Document

java.lang.Object

com.agisoft.metashape.Document

All Implemented Interfaces:

AutoCloseable

public class Document
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor	Description
	Document()
protected	Document(long cPtr, boolean cMemoryOwn)
	Document(Document document)

Method Summary

Modifier and Type	Method	Description
Chunk	addChunk()	Add a new empty chunk to the document.
void	append(Document document, Progress progress)	Append chunks from another document.
void	clear()	Remove all chunks from the project.
void	close()
void	delete()
String	dump()	Return document contents in XML format.
protected void	finalize()
Chunk	getActiveChunk()	Active chunk.
Optional<Chunk>	getChunk(int key)	Chunk with specified key, may be null.
int[]	getChunkKeys()	List of chunk keys in the document.
Chunk[]	getChunks()
protected static long	getCPtr(Document obj)
Map<String,String>	getMeta()	Get project meta data
String	getPath()
boolean	isReadOnly()	Read only status.
void	load(String text)	Initialize document contents from XML format.
void	open(String path, boolean read_only, Progress progress)	Open project.
void	remove(Chunk chunk)	Remove chunk from the project.
void	save(String path, int[] chunk_keys, Progress progress)	Save some chunks from the project.
void	save(String path, Progress progress)	Save project.
void	setActiveChunk(Chunk chunk)	Active chunk.
void	setMeta(Map<String,String> meta)	Set project meta data.
void	setReadOnly(boolean read_only)	Read only status.

Methods inherited from class java.lang.Object

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

Field Details

swigCMemOwn

protected transient boolean swigCMemOwn

Constructor Details

Document

protected Document(long cPtr,
 boolean cMemoryOwn)

Document

public Document()

Document

public Document(Document document)

Method Details

getCPtr

protected static long getCPtr(Document obj)

finalize

protected void finalize()

Overrides:

finalize in class Object

delete

public void delete()

close

public void close()

Specified by:

close in interface AutoCloseable

dump

public String dump()

Return document contents in XML format.

load

public void load(String text)

Initialize document contents from XML format.

clear

public void clear()

Remove all chunks from the project.

save

public void save(String path,
 Progress progress)

Save project.

Parameters:

path - Path to the file.

progress - Progress callback.

save

public void save(String path,
 int[] chunk_keys,
 Progress progress)

Save some chunks from the project.

Parameters:

path - Path to the file.

chunk_keys - List of chunks to be saved.

progress - Progress callback.

open

public void open(String path,
 boolean read_only,
 Progress progress)

Open project.

Parameters:

path - Path to the file.

read_only - Open document in read-only mode.

progress - Progress callback.

getPath

public String getPath()

Returns:

Path to the document file.

setReadOnly

public void setReadOnly(boolean read_only)

Read only status.

isReadOnly

public boolean isReadOnly()

Read only status.

addChunk

public Chunk addChunk()

Add a new empty chunk to the document.

Returns:

New chunk.

getChunks

public Chunk[] getChunks()

Returns:

List of chunks in the document.

getChunkKeys

public int[] getChunkKeys()

List of chunk keys in the document.

getChunk

public Optional<Chunk> getChunk(int key)

Chunk with specified key, may be null.

getActiveChunk

public Chunk getActiveChunk()

Active chunk.

setActiveChunk

public void setActiveChunk(Chunk chunk)

Active chunk.

remove

public void remove(Chunk chunk)

Remove chunk from the project.

Parameters:

chunk - Chunk to remove.

append

public void append(Document document,
 Progress progress)

Append chunks from another document.

Parameters:

document - Document to append.

setMeta

public void setMeta(Map<String,String> meta)

Set project meta data.

getMeta

public Map<String,String> getMeta()

Get project meta data