ccc.api.core
Class File

java.lang.Object
  ccc.api.core.Res
      ccc.api.core.Resource
          ccc.api.core.File

All Implemented Interfaces:

java.io.Serializable

public final class File
extends Resource

A summary of a file resource.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	LIST_BINARY LIST_BINARY : String.
static java.lang.String	SELF_BINARY SELF_BINARY : String.

Fields inherited from class ccc.api.core.Resource

ABSOLUTE_PATH, ACL, DELETE, DURATION, EXCLUDE_MM, INCLUDE_MM, LIST, LOCK, METADATA, NAME, PARENT, PUBLISH, REVISIONS, SELF, TEMPLATE, WC

Constructor Summary

File()
Constructor.

File(MimeType type, java.lang.String path, java.util.UUID id, ResourceName name, java.lang.String title, java.util.Map<java.lang.String,java.lang.String> properties)
Constructor.

File(MimeType mimeType, java.util.UUID data, long size, java.util.Map<java.lang.String,java.lang.String> properties)
Constructor.

File(java.util.UUID id, java.lang.String content, MimeType mimeType, boolean isMajorRevision, java.lang.String revisionComment)
Constructor.

File(java.util.UUID parentId, java.lang.String name, MimeType mimeType, boolean isMajorRevision, java.lang.String revisionComment, java.lang.String content)
Constructor.

Method Summary

java.lang.String	getCharset() Accessor.
java.lang.String	getComment() Accessor.
java.lang.String	getContent() Accessor.
java.util.UUID	getData() Accessor.
java.lang.String	getHeight() Accessor.
java.io.InputStream	getInputStream() Accessor.
MimeType	getMimeType() Accessor.
java.lang.String	getPath() Accessor.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Accessor.
long	getSize() Accessor.
java.lang.String	getWidth() Accessor.
boolean	isExecutable() Query if this file is executable.
boolean	isImage() Query if this file is an image.
boolean	isMajorEdit() Accessor.
boolean	isText() Query if this file is an text.
void	setCharset(java.lang.String charset) Mutator.
void	setComment(java.lang.String comment) Mutator.
void	setContent(java.lang.String content) Mutator.
void	setData(java.util.UUID data) Mutator.
void	setDataId(java.util.UUID dataId) Mutator.
void	setExecutable(boolean isExecutable) Mutator.
void	setImage(boolean isImage) Mutator.
void	setInputStream(java.io.InputStream inputStream) Mutator.
void	setMajorEdit(boolean isMajorEdit) Mutator.
void	setMimeType(MimeType mimeType) Mutator.
void	setPath(java.lang.String path) Mutator.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Mutator.
void	setSize(long size) Mutator.
void	setText(boolean isText) Mutator.

Methods inherited from class ccc.api.core.Resource

duration, getAbsolutePath, getCacheDuration, getDateChanged, getDateCreated, getDescription, getId, getLockedBy, getMetadata, getMetadatum, getName, getParent, getPublishedBy, getRevision, getTags, getTemplate, getTitle, getType, isCacheable, isInMainMenu, isLocked, isPublished, isSecure, isVisible, isWorkingCopy, self, setAbsolutePath, setCacheDuration, setDateChanged, setDateCreated, setDescription, setId, setInMainMenu, setLocked, setLockedBy, setMetadata, setName, setParent, setPublished, setPublishedBy, setRevision, setSecure, setTags, setTags, setTemplate, setTitle, setType, setVisible, uriMetadata, uriTemplate

Methods inherited from class ccc.api.core.Res

addLink, addLinks, getLink, getLinks

Methods inherited from class java.lang.Object

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

Field Detail

LIST_BINARY

public static final java.lang.String LIST_BINARY

LIST_BINARY : String.

See Also:

Constant Field Values

SELF_BINARY

public static final java.lang.String SELF_BINARY

SELF_BINARY : String.

See Also:

Constant Field Values

Constructor Detail

File

public File()

Constructor.

File

public File(java.util.UUID parentId,
            java.lang.String name,
            MimeType mimeType,
            boolean isMajorRevision,
            java.lang.String revisionComment,
            java.lang.String content)

Constructor.

Parameters:

parentId - The parent ID.

name - The file's name.

mimeType - The file's mime type.

isMajorRevision - Is this a major revision.

revisionComment - Comment describing the revision.

content - The file's content.

File

public File(MimeType mimeType,
            java.util.UUID data,
            long size,
            java.util.Map<java.lang.String,java.lang.String> properties)

Constructor.

Parameters:

mimeType - The file's mime type.

size - The file's size.

data - A reference to the files data.

properties - The file's properties.

File

public File(MimeType type,
            java.lang.String path,
            java.util.UUID id,
            ResourceName name,
            java.lang.String title,
            java.util.Map<java.lang.String,java.lang.String> properties)

Constructor.

Parameters:

type - The file's mime type.

path - The file's absolute path.

id - The file's id.

name - The file's name.

title - The file's title.

properties - The file's properties

File

public File(java.util.UUID id,
            java.lang.String content,
            MimeType mimeType,
            boolean isMajorRevision,
            java.lang.String revisionComment)

Constructor.

Parameters:

id - The file's ID.

content - The file's content.

mimeType - The file's mime-type.

isMajorRevision - Is this a major revision.

revisionComment - Comment describing the revision.

Method Detail

getMimeType

public MimeType getMimeType()

Accessor.

Returns:

Returns the mimeType.

getPath

public java.lang.String getPath()

Accessor.

Returns:

Returns the path.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Accessor.

Returns:

Returns the properties.

getCharset

public java.lang.String getCharset()

Accessor.

Returns:

The character set for the file or NULL if charset is available.

getData

public java.util.UUID getData()

Accessor.

Returns:

Returns the data.

setData

public void setData(java.util.UUID data)

Mutator.

Parameters:

data - The data to set.

getSize

public long getSize()

Accessor.

Returns:

Returns the size.

isImage

public boolean isImage()

Query if this file is an image.

Returns:

True if the file is an image, false otherwise.

isExecutable

public boolean isExecutable()

Query if this file is executable.

Returns:

True if the file is executable, false otherwise.

isText

public boolean isText()

Query if this file is an text.

Returns:

True if the file is a text, false otherwise.

setDataId

public void setDataId(java.util.UUID dataId)

Mutator.

Parameters:

dataId - The dataId to set.

setCharset

public void setCharset(java.lang.String charset)

Mutator.

Parameters:

charset - The charset to set.

setSize

public void setSize(long size)

Mutator.

Parameters:

size - The size to set.

setImage

public void setImage(boolean isImage)

Mutator.

Parameters:

isImage - The isImage to set.

setExecutable

public void setExecutable(boolean isExecutable)

Mutator.

Parameters:

isExecutable - The isExecutable to set.

setText

public void setText(boolean isText)

Mutator.

Parameters:

isText - The isText to set.

setMimeType

public void setMimeType(MimeType mimeType)

Mutator.

Parameters:

mimeType - The mimeType to set.

setComment

public void setComment(java.lang.String comment)

Mutator.

Parameters:

comment - to set.

setMajorEdit

public void setMajorEdit(boolean isMajorEdit)

Mutator.

Parameters:

isMajorEdit - to set.

isMajorEdit

public boolean isMajorEdit()

Accessor.

Returns:

Returns the isMajorEdit.

getComment

public java.lang.String getComment()

Accessor.

Returns:

Returns the comment.

getInputStream

public java.io.InputStream getInputStream()

Accessor.

Returns:

Returns the input stream.

setInputStream

public void setInputStream(java.io.InputStream inputStream)

Mutator.

Parameters:

inputStream - The input stream to set.

getContent

public java.lang.String getContent()

Accessor.

Returns:

Returns the content.

setPath

public void setPath(java.lang.String path)

Mutator.

Parameters:

path - The path to set.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Mutator.

Parameters:

properties - The properties to set.

setContent

public void setContent(java.lang.String content)

Mutator.

Parameters:

content - The content to set.

getWidth

public java.lang.String getWidth()

Accessor.

Returns:

The width of the image resource.

getHeight

public java.lang.String getHeight()

Accessor.

Returns:

The height of the image resource.