DEPRECATED

# com.bea.p13n.content.document.ref
DefaultDocumentMetadata Class

public class DefaultDocumentMetadata
extends `Object`
implements `com.bea.p13n.content.document.spi.DocumentMetadataDef`

A concreate implementation of DocumentMetadata.

Hierarchy
  `Object`
  `DefaultDocumentMetadata`

All Implemented Interfaces
  `com.bea.p13n.content.document.spi.DocumentMetadataDef`

Direct Known Subclasses
  `com.bea.p13n.content.document.ref.RefDocumentMetadata`

## Field Summary

`protected `Map`` | `attributes` The map of attribute name to attribute value.
`protected `String`` | `author` The document author.
`protected `String`` | `comments` The document comments.
`protected `Timestamp`` | `creationDate` The document creation date.
`protected `String`` | `description` The document description.
`protected `String`` | `id` The document id.
`protected `String`` | `lastModifiedBy` The document last modified by.
`protected `Timestamp`` | `lastModifiedDate` The document last modified date.
`protected `String`` | `lockedBy` The document locked by.
`protected `String`` | `mimeType` The document mime type.
`protected `String`` | `name` The document name.
`protected long` | `size` The document size.
`protected int` | `version` The document version.

## Constructor Summary

DefaultDocumentMetadata() Constructor.
DefaultDocumentMetadata(`String` id, `String` name, `String` mimeType) Constructor.
DefaultDocumentMetadata(`String` id, `String` name) Constructor.
DefaultDocumentMetadata(`String` id) Constructor.

## Method Summary

`public `Object`` | `getAttribute`(`String` name) Get the named attribute.
`public `Collection`` | `getAttributeNames`() Return the collection of the attribute names.
`public `Map`` | `getAttributes`() Get the map of attribute names to attribute values.
`public `String`` | `getAuthor`() Get the document author.
`public `String`` | `getComments`() Get the document comments.
`public `Timestamp`` | `getCreationDate`() Get the document creation date.
`public `String`` | `getDescription`() Get the document description.
`public `String`` | `getID`() Get the document id.
`public `String`` | `getLastModifiedBy`() Get the document last modified by.
`public `Timestamp`` | `getLastModifiedDate`() Get the last modified date.
`public `String`` | `getLockedBy`() Get the document locked by.
`public `String`` | `getMimeType`() Get the mime type.
`public `String`` | `getName`() Get the document name.
`public long` | `getSize`() Get the document size.
`public int` | `getVersion`() Get the document version.
`public void` | `setAuthor`(`String` author) Set the document author.
`public void` | `setComments`(`String` comments) Set the document comments.
`public void` | `setCreationDate`(`Timestamp` date) Set the document creation date.
`public void` | `setDescription`(`String` description) Set the document description.
`public void` | `setID`(`String` id) Set the document id.
`public void` | `setLastModifiedBy`(`String` lastModifiedBy) Set the document last modified by.
`public void` | `setLastModifiedDate`(`Timestamp` date) Set the last modified date.
`public void` | `setLockedBy`(`String` lockedBy) Set the document locked by.
`public void` | `setMimeType`(`String` mimeType) Set the mime type.
`public void` | `setName`(`String` name) Set the document name.
`public void` | `setSize`(long size) Set the document size.
`public void` | `setVersion`(int version) Set the document version.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.p13n.content.document.spi.`com.bea.p13n.content.document.spi.DocumentMetadataDef``
``getAttribute`, `getAttributeNames`, `getAuthor`, `getComments`, `getCreationDate`, `getDescription`, `getID`, `getLastModifiedBy`, `getLastModifiedDate`, `getLockedBy`, `getMimeType`, `getName`, `getSize`, `getVersion``

## Field Detail

### attributes

    protected Map attributes

  The map of attribute name to attribute value.

### author

    protected String author

  The document author.

### comments

    protected String comments

  The document comments.

### creationDate

    protected Timestamp creationDate

  The document creation date.

### description

    protected String description

  The document description.

### id

    protected String id

  The document id.

### lastModifiedBy

    protected String lastModifiedBy

  The document last modified by.

### lastModifiedDate

    protected Timestamp lastModifiedDate

  The document last modified date.

### lockedBy

    protected String lockedBy

  The document locked by.

### mimeType

    protected String mimeType

  The document mime type.

### name

    protected String name

  The document name.

### size

    protected long size

  The document size.

### version

    protected int version

  The document version.

## Constructor Detail

### DefaultDocumentMetadata

    public DefaultDocumentMetadata()

  Constructor.

### DefaultDocumentMetadata

    public DefaultDocumentMetadata(String id,
                                   String name,
                                   String mimeType)

  Constructor.

### DefaultDocumentMetadata

    public DefaultDocumentMetadata(String id,
                                   String name)

  Constructor.

### DefaultDocumentMetadata

    public DefaultDocumentMetadata(String id)

  Constructor.

## Method Detail

### getAttribute(String) Method

    public Object getAttribute(String name)

Get the named attribute.

#### Parameters

name
  the name of the attribute.

#### Returns

the value of the attribute (null if not set).

### getAttributeNames() Method

    public Collection getAttributeNames()

Return the collection of the attribute names.

#### Returns

the list of String attribute names.

### getAttributes() Method

    public Map getAttributes()

Get the map of attribute names to attribute values.

### getAuthor() Method

    public String getAuthor()

Get the document author.

### getComments() Method

    public String getComments()

Get the document comments.

### getCreationDate() Method

    public Timestamp getCreationDate()

Get the document creation date.

### getDescription() Method

    public String getDescription()

Get the document description.

### getID() Method

    public String getID()

Get the document id.

### getLastModifiedBy() Method

    public String getLastModifiedBy()

Get the document last modified by.

### getLastModifiedDate() Method

    public Timestamp getLastModifiedDate()

Get the last modified date.

### getLockedBy() Method

    public String getLockedBy()

Get the document locked by.

### getMimeType() Method

    public String getMimeType()

Get the mime type.

### getName() Method

    public String getName()

Get the document name.

### getSize() Method

    public long getSize()

Get the document size.

### getVersion() Method

    public int getVersion()

Get the document version.

### setAuthor(String) Method

    public void setAuthor(String author)

Set the document author.

### setComments(String) Method

    public void setComments(String comments)

Set the document comments.

### setCreationDate(Timestamp) Method

    public void setCreationDate(Timestamp date)

Set the document creation date.

### setDescription(String) Method

    public void setDescription(String description)

Set the document description.

### setID(String) Method

    public void setID(String id)

Set the document id.

### setLastModifiedBy(String) Method

    public void setLastModifiedBy(String lastModifiedBy)

Set the document last modified by.

### setLastModifiedDate(Timestamp) Method

    public void setLastModifiedDate(Timestamp date)

Set the last modified date.

### setLockedBy(String) Method

    public void setLockedBy(String lockedBy)

Set the document locked by.

### setMimeType(String) Method

    public void setMimeType(String mimeType)

Set the mime type.

### setName(String) Method

    public void setName(String name)

Set the document name.

### setSize(long) Method

    public void setSize(long size)

Set the document size.

### setVersion(int) Method

    public void setVersion(int version)

Set the document version.