Package org.mycore.datamodel.ifs2

Class MCRFile

java.lang.Object

org.mycore.datamodel.ifs2.MCRNode

org.mycore.datamodel.ifs2.MCRStoredNode

org.mycore.datamodel.ifs2.MCRFile

public class MCRFile
extends MCRStoredNode

Represents a file stored in a file collection. This is a file that is imported from outside the system, and may be updated and modified afterwards.

Author:

Frank Lützenkirchen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MD5_OF_EMPTY_FILE	The md5 checksum of the empty file

Fields inherited from class org.mycore.datamodel.ifs2.MCRNode

parent, path

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MCRFile(MCRDirectory parent, String name)	Creates a new MCRFile that does not exist yet
protected	MCRFile(MCRDirectory parent, Path fo, Element data)	Returns a MCRFile object representing an existing file already stored in the store.

Method Summary

Modifier and Type	Method	Description
protected MCRVirtualNode	buildChildNode(Path fo)	Returns a MCRVirtualNode contained in this file as a child.
MCRFileAttributes<String>	getBasicFileAttributes()
String	getExtension()	Returns the file name extension, which is the part after the last dot in the filename.
String	getMD5()	Returns the md5 checksum of the file's content.
String	setContent(MCRContent source)	Sets the content of this file.
void	setMD5(String md5)	updates the MD5 sum of this file to the given value.

Methods inherited from class org.mycore.datamodel.ifs2.MCRStoredNode

clearLabels, delete, getCurrentLabel, getLabel, getLabels, getLocalFile, getLocalPath, readData, renameTo, setLabel, setLastModified, writeData

Methods inherited from class org.mycore.datamodel.ifs2.MCRNode

getChild, getChildren, getContent, getLastModified, getName, getNodeByPath, getNumChildren, getParent, getPath, getRandomAccessContent, getRoot, getSize, hasChildren, isDirectory, isFile

Methods inherited from class java.lang.Object

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

Field Details

MD5_OF_EMPTY_FILE

public static final String MD5_OF_EMPTY_FILE

The md5 checksum of the empty file

See Also:

• Constant Field Values

Constructor Details

MCRFile

protected MCRFile(MCRDirectory parent,
 Path fo,
 Element data)

Returns a MCRFile object representing an existing file already stored in the store.

Parameters:

parent - the parent directory containing this file

fo - the file in the local underlying filesystem storing this file

MCRFile

protected MCRFile(MCRDirectory parent,
 String name)
           throws IOException

Creates a new MCRFile that does not exist yet

Parameters:

parent - the parent directory

name - the file name

Throws:

IOException

Method Details

buildChildNode

protected MCRVirtualNode buildChildNode(Path fo)

Returns a MCRVirtualNode contained in this file as a child. A file that is a container, like zip or tar, may contain other files as children.

Specified by:

buildChildNode in class MCRNode

Parameters:

fo - the FileObject representing the child in the underlying filesystem

Returns:

the child node or null, if the fo does not exists

getMD5

public String getMD5()

Returns the md5 checksum of the file's content.

Returns:

the md5 checksum of the file's content.

getExtension

public String getExtension()

Returns the file name extension, which is the part after the last dot in the filename.

Returns:

the file extension, or the empty string if the file name does not have an extension

setContent

public String setContent(MCRContent source)
                  throws IOException

Sets the content of this file.

Parameters:

source - the content to be read

Returns:

the MD5 checksum of the stored content

Throws:

IOException

setMD5

public void setMD5(String md5)
            throws IOException

updates the MD5 sum of this file to the given value. Use only if you modified the content outside of setContent(MCRContent).

Parameters:

md5 -

Throws:

IOException

getBasicFileAttributes

public MCRFileAttributes<String> getBasicFileAttributes()
                                                 throws IOException

Overrides:

getBasicFileAttributes in class MCRStoredNode

Throws:

IOException