java.lang.Comparable<LibraryResource>
LibraryCollection
public class LibraryResource extends java.lang.Object implements java.lang.Comparable<LibraryResource>
Modifier and Type | Class | Description |
---|---|---|
protected static class |
LibraryResource.Metadata |
A Comparable class for metadata key-value pairs.
|
Modifier and Type | Field | Description |
---|---|---|
protected static java.util.List<java.lang.String> |
allResourceTypes |
|
protected static java.awt.Font |
bodyFont |
|
static java.lang.String |
COLLECTION_TYPE |
|
protected java.lang.String |
collectionPath |
|
protected java.lang.String |
displayName |
|
static java.lang.String |
EJS_TYPE |
|
protected static ResizableIcon |
ejsIcon |
|
protected static java.awt.Font |
h1Font |
|
protected static java.awt.Font |
h2Font |
|
static java.lang.String |
HTML_TYPE |
|
protected static ResizableIcon |
htmlIcon |
|
static java.lang.String |
IMAGE_TYPE |
|
protected static javax.swing.filechooser.FileFilter[] |
imageFilters |
|
protected static ResizableIcon |
imageIcon |
|
protected static java.text.DecimalFormat |
megabyteFormat |
|
static java.lang.String |
META_AUTHOR |
|
static java.lang.String |
META_CONTACT |
|
static java.lang.String |
META_KEYWORDS |
|
static java.lang.String[] |
META_TYPES |
|
protected LibraryCollection |
parent |
|
static java.lang.String |
PDF_TYPE |
|
protected static ResizableIcon |
pdfIcon |
|
protected static java.lang.String[] |
RESOURCE_TYPES |
|
protected java.lang.String |
target |
|
static java.lang.String |
TRACKER_TYPE |
|
protected static ResizableIcon |
trackerIcon |
|
protected java.util.List<java.lang.String> |
treePath |
|
static java.lang.String |
UNKNOWN_TYPE |
|
protected static ResizableIcon |
unknownIcon |
|
static java.lang.String |
VIDEO_TYPE |
|
protected static ResizableIcon |
videoIcon |
Constructor | Description |
---|---|
LibraryResource(java.lang.String name) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addMetadata(LibraryResource.Metadata data) |
Adds a Metadata object to the metadata.
|
int |
compareTo(LibraryResource resource) |
Compares this to the specified resource.
|
boolean |
equals(java.lang.Object obj) |
|
java.lang.String |
getBasePath() |
Gets the base path.
|
protected static java.lang.String |
getBodyStyle() |
Returns the body style for a stylesheet.
|
LibraryResource |
getClone() |
Gets a clone of this resource.
|
java.lang.String |
getCollectionPath() |
Gets the collection path for this resource.
|
java.lang.String |
getDescription() |
Gets the description, which must be in html code.
|
protected static java.lang.String |
getH1Style() |
Returns the H1 heading style for a stylesheet.
|
protected static java.lang.String |
getH2Style() |
Returns the H2 heading style for a stylesheet.
|
protected static java.lang.String |
getHTMLBody(java.lang.String title,
java.lang.String resourceType,
java.lang.String thumbnailPath,
java.lang.String description,
java.lang.String authors,
java.lang.String contact,
java.lang.String moreInfoURL,
java.lang.String[] attachment) |
Gets html code for a resource with specified properties.
|
static java.lang.String |
getHTMLCode(java.lang.String title,
java.lang.String resourceType,
java.lang.String thumbnailPath,
java.lang.String description,
java.lang.String authors,
java.lang.String contact,
java.lang.String moreInfoURL,
java.lang.String[] attachment,
java.util.Map<java.lang.String,java.lang.String> data) |
Gets the html code for a resource with specified properties.
|
java.lang.String |
getHTMLPath() |
Gets the path to the html page displayed in the browser.
|
javax.swing.Icon |
getIcon() |
Gets the icon for the tree node associated with this resource.
|
protected java.lang.String |
getInheritedBasePath() |
Returns the first base path found in this or its ancestors.
|
static XML.ObjectLoader |
getLoader() |
Returns an ObjectLoader to save and load data for this class.
|
java.util.TreeSet<LibraryResource.Metadata> |
getMetadata() |
Gets the metadata.
|
LibraryResource.Metadata |
getMetadata(java.lang.String key) |
Gets the first metadata of a specified type.
|
java.lang.String |
getName() |
Gets the name of this resource (never null).
|
java.lang.String |
getProperty(java.lang.String name) |
Gets a property value.
|
java.util.Set<java.lang.String> |
getPropertyNames() |
Returns the names of all defined properties.
|
protected static java.lang.String |
getStyleSheetCode() |
Returns the H2 heading style for a stylesheet.
|
java.lang.String |
getTarget() |
Gets the target of this resource (file name or comPADRE command).
|
java.lang.String |
getThumbnail() |
Gets the thumbnail of this resource, if any.
|
java.lang.String |
getTitle(java.lang.String path) |
Gets a title for tabs.
|
protected java.util.List<java.lang.String> |
getTreePath(java.util.List<java.lang.String> pathComponents) |
Gets the tree path for this node.
|
java.lang.String |
getType() |
Gets the type of resource.
|
protected static java.lang.String |
insertLineBreaks(java.lang.String text) |
Inserts HTML line breaks where new lines occur in text.
|
boolean |
removeMetadata(LibraryResource.Metadata data) |
Removes a Metadata object from the metadata.
|
boolean |
setBasePath(java.lang.String path) |
Sets the base path of this resource.
|
boolean |
setDescription(java.lang.String desc) |
Sets the description of this resource.
|
boolean |
setHTMLPath(java.lang.String path) |
Sets the html path of this resource.
|
void |
setMetadata(java.util.TreeSet<LibraryResource.Metadata> data) |
Sets the metadata.
|
boolean |
setName(java.lang.String aName) |
Sets the name of this resource.
|
void |
setProperty(java.lang.String name,
java.lang.String value) |
Sets an arbitrary String property.
|
boolean |
setTarget(java.lang.String path) |
Sets the target of this resource.
|
void |
setThumbnail(java.lang.String imagePath) |
Sets the thumbnail for this resource.
|
boolean |
setType(java.lang.String type) |
Sets the type of this resource.
|
java.lang.String |
toString() |
public static final java.lang.String META_AUTHOR
public static final java.lang.String META_CONTACT
public static final java.lang.String META_KEYWORDS
public static final java.lang.String[] META_TYPES
public static final java.lang.String UNKNOWN_TYPE
public static final java.lang.String COLLECTION_TYPE
public static final java.lang.String TRACKER_TYPE
public static final java.lang.String EJS_TYPE
public static final java.lang.String VIDEO_TYPE
public static final java.lang.String IMAGE_TYPE
public static final java.lang.String HTML_TYPE
public static final java.lang.String PDF_TYPE
protected static final java.lang.String[] RESOURCE_TYPES
protected static java.util.List<java.lang.String> allResourceTypes
protected static ResizableIcon htmlIcon
protected static ResizableIcon videoIcon
protected static ResizableIcon trackerIcon
protected static ResizableIcon ejsIcon
protected static ResizableIcon pdfIcon
protected static ResizableIcon unknownIcon
protected static ResizableIcon imageIcon
protected static javax.swing.filechooser.FileFilter[] imageFilters
protected static java.text.DecimalFormat megabyteFormat
protected static java.awt.Font bodyFont
protected static java.awt.Font h1Font
protected static java.awt.Font h2Font
protected java.lang.String target
protected java.lang.String displayName
protected LibraryCollection parent
protected java.lang.String collectionPath
protected java.util.List<java.lang.String> treePath
public LibraryResource(java.lang.String name)
name
- the name of the resourcepublic java.lang.String getName()
public boolean setName(java.lang.String aName)
aName
- the namepublic java.lang.String getBasePath()
public boolean setBasePath(java.lang.String path)
path
- the base pathprotected java.lang.String getInheritedBasePath()
public java.lang.String getTarget()
public boolean setTarget(java.lang.String path)
path
- the target pathpublic java.lang.String getHTMLPath()
public boolean setHTMLPath(java.lang.String path)
path
- the html pathpublic java.lang.String getDescription()
public boolean setDescription(java.lang.String desc)
desc
- the description in HTML codepublic java.lang.String getType()
public boolean setType(java.lang.String type)
type
- the typepublic java.util.TreeSet<LibraryResource.Metadata> getMetadata()
public LibraryResource.Metadata getMetadata(java.lang.String key)
key
- the typepublic void setMetadata(java.util.TreeSet<LibraryResource.Metadata> data)
data
- a Set of Metadata (may be null)public void addMetadata(LibraryResource.Metadata data)
data
- the Metadatapublic boolean removeMetadata(LibraryResource.Metadata data)
data
- the Metadatapublic void setProperty(java.lang.String name, java.lang.String value)
name
- the name of the propertyvalue
- the value of the propertypublic java.lang.String getProperty(java.lang.String name)
name
- the name of the propertypublic java.util.Set<java.lang.String> getPropertyNames()
public javax.swing.Icon getIcon()
public java.lang.String getThumbnail()
public void setThumbnail(java.lang.String imagePath)
imagePath
- the path to a thumbnail imagepublic java.lang.String getCollectionPath()
public java.lang.String getTitle(java.lang.String path)
path
- the path to the xml file associated with this resource (may be null)public java.lang.String toString()
toString
in class java.lang.Object
public int compareTo(LibraryResource resource)
compareTo
in interface java.lang.Comparable<LibraryResource>
resource
- the resource to comparepublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public LibraryResource getClone()
protected java.util.List<java.lang.String> getTreePath(java.util.List<java.lang.String> pathComponents)
pathComponents
- a List of Strings in root-to-leaf order that represent this pathpublic static java.lang.String getHTMLCode(java.lang.String title, java.lang.String resourceType, java.lang.String thumbnailPath, java.lang.String description, java.lang.String authors, java.lang.String contact, java.lang.String moreInfoURL, java.lang.String[] attachment, java.util.Map<java.lang.String,java.lang.String> data)
title
- the name of the resourceresourceType
- one of the LibraryResource defined typesthumbnailPath
- path to the thumbnail image filedescription
- a description of the resourceauthors
- authorscontact
- author contact information or institutionmoreInfoURL
- link to external HTML with more information about the resourceattachment
- String[] {downloadURL, filename, sizeInBytes} (used for ComPADRE)data
- Map of metadata names to valuesprotected static java.lang.String getHTMLBody(java.lang.String title, java.lang.String resourceType, java.lang.String thumbnailPath, java.lang.String description, java.lang.String authors, java.lang.String contact, java.lang.String moreInfoURL, java.lang.String[] attachment)
title
- the name of the resourceresourceType
- one of the LibraryResource defined typesthumbnailPath
- path to the thumbnail image filedescription
- a description of the resourceauthors
- authorscontact
- author contact information or institutionmoreInfoURL
- link to external HTML with more information about the resourceattachment
- String[] {downloadURL, filename, sizeInBytes} (used for ComPADRE)protected static java.lang.String getBodyStyle()
protected static java.lang.String getH1Style()
protected static java.lang.String getH2Style()
protected static java.lang.String getStyleSheetCode()
protected static java.lang.String insertLineBreaks(java.lang.String text)
text
- the textpublic static XML.ObjectLoader getLoader()