public final class FolderView extends Object implements XMLSerializable, XMLSerializable.OldVersionCompatible
XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportTypeROOT_ELEMENT_NAME| Constructor and Description |
|---|
FolderView(org.jdom.Element element)
XML deserialization constructor.
|
FolderView(List<DocumentField> propertyFields,
DocumentField defaultSortingField)
Constuct a new FolderView
|
| Modifier and Type | Method and Description |
|---|---|
void |
addChangeListener(SimpleListener changeListener)
Add a listener which is notified whenever the contents of the folder view folder is changed.
|
void |
addDocumentProperties(Map<URN,Map<String,Object>> searchResultProperties)
Update search properties for several documents at once.
|
void |
addDocumentProperties(URN documentUrn,
Map<String,Object> searchResultProperties)
Add a set of properties associated with a document.
|
void |
fromXML(org.jdom.Element element)
Restore the object from the JDOM Element returned by
XMLSerializable.toXML(). |
DocumentField |
getDefaultSortingField()
Get the default field on which to sort documents.
|
List<URN> |
getDocumentUrns()
Get the URNs of all documents for which properties are stored in this folder view.
|
Map<String,Object> |
getPropertiesForDocument(URN documentUrn)
Get the stored properties for a document
|
List<DocumentField> |
getPropertyFields()
Get the field definitions for any properties that may appear on documents.
|
Geneious.MajorVersion |
getVersionSupport(XMLSerializable.VersionSupportType versionType)
Gets either the latest version this class can serialize to via
XMLSerializable.OldVersionCompatible.toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener)
or the most recent version in which the XML returned from XMLSerializable.OldVersionCompatible.toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) last changed. |
void |
removeChangeListener(SimpleListener changeListener)
Remove a listener added using
addChangeListener(org.virion.jam.util.SimpleListener). |
void |
removeDocumentProperties(URN documentUrn)
Removes any properties associated with this document.
|
org.jdom.Element |
toXML()
Convert object to a JDOM element.
|
org.jdom.Element |
toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener)
Serializes this class to XML format, potentially to a format readable by an earlier version of Geneious.
|
public FolderView(List<DocumentField> propertyFields, DocumentField defaultSortingField)
propertyFields - Any properties field definitions that may be attached to documents in this folder. Must not be null, but may be empty.defaultSortingField - One of the fields in searchResultProperties or null if there is no default field on which to sort.public FolderView(org.jdom.Element element)
throws XMLSerializationException
element - the element to deserialize from that was previously returned from toXML().XMLSerializationExceptionpublic void addDocumentProperties(URN documentUrn, Map<String,Object> searchResultProperties)
documentUrn - the URN of the document to associate properties withsearchResultProperties - the properties to associate with that document which must not be null, but may be empty.
Any existing properties for the document will be replaced.WritableDatabaseService.createFolderViewFolder(String, com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument)public void addDocumentProperties(Map<URN,Map<String,Object>> searchResultProperties)
addDocumentProperties(com.biomatters.geneious.publicapi.documents.URN, java.util.Map)
except that it only updates the folder view after all properties have been set instead of after each one, meaning
it is faster when adding properties for many documents at once.searchResultProperties - a map of properties for several document urns, must not be null.
Any existing properties for the documents will be replaced.public void addChangeListener(SimpleListener changeListener)
changeListener - Listener to be notified of changespublic void removeChangeListener(SimpleListener changeListener)
addChangeListener(org.virion.jam.util.SimpleListener).changeListener - Listener to removepublic void removeDocumentProperties(URN documentUrn)
documentUrn - the URN of the document to associate properties withpublic List<URN> getDocumentUrns()
DocumentUtilities.getDocumentByURN(com.biomatters.geneious.publicapi.documents.URN)
for getting the document from its URN.public Map<String,Object> getPropertiesForDocument(URN documentUrn)
documentUrn - the URN of the document to get properties for.public List<DocumentField> getPropertyFields()
public DocumentField getDefaultSortingField()
public org.jdom.Element toXML()
XMLSerializableXMLSerializable.fromXML(org.jdom.Element) can completely
restore the objects representation.
It is recommended that the returned element use XMLSerializable.ROOT_ELEMENT_NAME as its name,
in which case it must not define an attribute called "type". In this case,
fromXML, will be called with an element whose name may differ from the element
return from this function. This recommendation allows a more compact representation
of the XML can be stored.
This method generally should not be called directly. Instead, you should usually call
XMLSerializer.classToXML(String, XMLSerializable)
which calls this method internally.
PluginDocument implementations of this method may choose to throw an XMLSerializationException,
enclosed in a RuntimeException.toXML in interface XMLSerializablepublic Geneious.MajorVersion getVersionSupport(XMLSerializable.VersionSupportType versionType)
XMLSerializable.OldVersionCompatibleXMLSerializable.OldVersionCompatible.toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener)
or the most recent version in which the XML returned from XMLSerializable.OldVersionCompatible.toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) last changed.getVersionSupport in interface XMLSerializable.OldVersionCompatibleversionType - specifies which version property to returnpublic org.jdom.Element toXML(Geneious.MajorVersion majorVersion, ProgressListener progressListener)
XMLSerializable.OldVersionCompatibleXMLSerializable.toXML() for a more
detailed description of what it means to serialize to XML.
All classes that implement this method must also implement XMLSerializable.toXML() and should delegate back to
this method using Geneious.getMajorVersion() and ProgressListener.EMPTY as parameters.toXML in interface XMLSerializable.OldVersionCompatiblemajorVersion - the major version of Geneious to serialize to XML for. For example "6.0" but not "6.0.0". This must be a version
returned greater or equal to a version returned from
getVersionSupport(VersionSupportType.OldestVersionSerializableTo)
and must never be greater than the current version (Geneious.getMajorVersion())progressListener - for reporting progress and cancellingpublic void fromXML(org.jdom.Element element)
throws XMLSerializationException
XMLSerializableXMLSerializable.toXML().
This method generally should not be called directly. Instead, you should usually call
XMLSerializer.classFromXML(org.jdom.Element)
or XMLSerializer.classFromXML(org.jdom.Element, Class)
which calls this method internally.
It is optional to implement this method. Instead of implementing an empty constructor and implementing
this method properly, the implementation may instead
throw an UnsupportedOperationException and implement a constructor
that takes a single Element as a parameter.
This allows for cleaner code such as support for final fields in the XMLSerializable class.
The element parameter should not be modified since it may be reused. If you need a modified version of it,
take a copy with Element.clone().fromXML in interface XMLSerializableelement - representation from a previous call to XMLSerializable.toXML()XMLSerializationException - if the Element can't be converted into this type of object