Package uk.ac.starlink.topcat
Class TopcatCodec2
java.lang.Object
uk.ac.starlink.topcat.TopcatCodec2
- All Implemented Interfaces:
TopcatCodec
Second version of TopcatCodec implementation.
This defines a different serialization format to the older
TopcatCodec1
,
and unlike that, this one stores the algebraic expressions
etc for algebraically-defined columns and subsets,
as well as the definition of some other RowSubset variants
like ones based on other subsets or columns.
It can thus preserve state better and also requires less storage.- Since:
- 6 Sep 2017
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondecode
(uk.ac.starlink.table.StarTable table, String location, ControlWindow controlWindow) uk.ac.starlink.table.StarTable
encode
(TopcatModel tcModel) Turns a TopcatModel into a StarTable, ready for serialization.boolean
isEncoded
(uk.ac.starlink.table.StarTable table) Indicates whether a given table is a candidate for this codec'sdecode
method.
-
Constructor Details
-
TopcatCodec2
public TopcatCodec2()
-
-
Method Details
-
encode
Description copied from interface:TopcatCodec
Turns a TopcatModel into a StarTable, ready for serialization.- Specified by:
encode
in interfaceTopcatCodec
- Parameters:
tcModel
- model- Returns:
- table
-
isEncoded
public boolean isEncoded(uk.ac.starlink.table.StarTable table) Description copied from interface:TopcatCodec
Indicates whether a given table is a candidate for this codec'sdecode
method. It should in general return true for a table that has been returned from this object'sencode
method (possibly following a table write/read cycle) and false for other tables.- Specified by:
isEncoded
in interfaceTopcatCodec
- Parameters:
table
- data+metadata table- Returns:
- true iff it looks like the table was written by this codec and can be decoded by it
-
decode
public TopcatModel decode(uk.ac.starlink.table.StarTable table, String location, ControlWindow controlWindow) Description copied from interface:TopcatCodec
Takes a table which has been previously serialized by calling this codec'sencode
method, and for which theisEncoded
method returns true, and turns it into a TopcatModel. If decoding fails, null is returned.If used with a ControlWindow that users may be interacting with, this method should be called from the AWT event dispatch thread. This method may (for instance during testing) be called with a null value for the
controlWindow
parameter, but the resulting TopcatModel may not be suitable for all kinds of user interactions.- Specified by:
decode
in interfaceTopcatCodec
- Parameters:
table
- encoded tablelocation
- table location stringcontrolWindow
- control window, or null if necessary- Returns:
- topcat model, or null
-