All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Folder

java.lang.Object
   |
   +----icc.db.Folder

public class Folder

extends Object

implements Serializable

The selected documents may have other information in common, as defined in the criteria. Additionally, the selected documents may be required as having the same type, or sharing a keyword in their content texts. Furthermore an expansion may be specified, with the result that all links of the specified type are followed and the resulting documents added to the folder. The expansion link types that can be specified are CONTAINS, FOLLOW_UP and NEXT_VERSION.

The documents in a folder are organized into a hierarchy depending on their grouping, threading and versioning links. Top level documents are those documents that do not belong or reply to any other document in the folder, nor have a next version in the folder.

See Also:

Header, File, Select

CONTAINS

A useful constant to specify the expansion link name for documents that are contained by selected documents.

FOLLOW_UP

A useful constant to specify the expansion link name for documents that follow up on selected documents.

NEXT_VERSION

A useful constant to specify the expansion link name for documents that are next versions of selected documents.

view

This vector specifies the top level documents in this folder.

Folder(Cube)

Allocates a Folder object with the specified project cube.

Folder(Cube, Select)

Folder(Cube, String)

Allocates a Folder object with the specified project cube and common document categories.

Folder(Cube, String, String)

Allocates a Folder object with the specified project cube, common document type and common document categories.

add(Header)

Adds a document to this folder.

categories()

returns a vector of common categories defined for all documents in this folder.

clear()

Removes all documents from this folder.

contains(Integer)

Checks if the specified document is contained in this folder.

cube()

Returns the project cube of this folder.

equals(Object)

Compares this object to the specified object.

expansion()

Returns the expansion link name defined for this folder, if any.

files()

Returns an enumeration of all the documents contained in this folder.

find(String)

Returns the document in this folder with the specified title.

get(Integer)

Returns the document corresponding the specified identifier, if contained in this folder.

getCategories()

Returns the common document categories as a string with categories separated by spaces.

getCriteria()

returns the criteria defined for all documents in this folder.

jscube()

Returns the project cube of this folder.

keyword()

Returns the common keyword defined for this folder, if any.

project()

Returns the project identifier of this folder.

put()

Stores all documents in this folder for later retrieval.

remove(Header)

Removes a document from this folder.

removeType()

Unsets the common document type.

retrieve(Boolean)

Creates a data request to retrieve all documents that belong to this folder.

retrieve(boolean)

Creates a data request to retrieve all documents that belong to this folder.

setCategories(String)

Sets the common categories.

setCube(String, String, String)

Sets the folder's project cube.

setExpansion(String)

Sets the expansion link name.

setKeyword(String)

Sets the common keyword.

setType(String)

Sets the common document type.

size()

Returns the number of documents contained in this folder.

topLevel(Header)

Tests if the specified document is a top level document in this folder.

type()

Returns the common document type defined for this folder, if any.

 public static final String CONTAINS

A useful constant to specify the expansion link name for documents that are contained by selected documents.

 public static final String FOLLOW_UP

A useful constant to specify the expansion link name for documents that follow up on selected documents.

 public static final String NEXT_VERSION

A useful constant to specify the expansion link name for documents that are next versions of selected documents.

 public Vector view

This vector specifies the top level documents in this folder.

 Folder(Cube cube,
        Select criteria)

 public Folder(Cube cube,
               String type,
               String categories)

Allocates a Folder object with the specified project cube, common document type and common document categories.

Parameters:

cube - a project cube

type - a document type, one of TEXT, URL, PATH and PURSE

categories - a string of categories separated by spaces

See Also:

TEXT, URL, PATH, PURSE

 public Folder(Cube cube,
               String categories)

Allocates a Folder object with the specified project cube and common document categories.

Parameters:

cube - a project cube

categories - a string of categories separated by spaces

 public Folder(Cube cube)

Allocates a Folder object with the specified project cube.

Parameters:

cube - a project cube

 public Cube cube()

Returns the project cube of this folder.

Returns:

a project cube

 public Cube jscube()

Returns the project cube of this folder. This method is accessible from JavaScript.

Returns:

a project cube

 public Integer project()

Returns the project identifier of this folder.

Returns:

a project identifier

 public String type()

Returns the common document type defined for this folder, if any.

Returns:

a document type; null if none is defined

 public String keyword()

Returns the common keyword defined for this folder, if any.

Returns:

a keyword; null if none is defined

 public String expansion()

Returns the expansion link name defined for this folder, if any. When retrieving a folder, all links of the specified name to documents within this project cube are followed and the resulting documents retrieved as well.

Returns:

a keyword; null if none is defined

 public boolean contains(Integer id)

Checks if the specified document is contained in this folder.

Parameters:

id - a document identifier

Returns:

true if this folder contains the document; false otherwise

 public Header get(Integer id)

Returns the document corresponding the specified identifier, if contained in this folder.

Parameters:

id - a document identifier

Returns:

a document or document header

 public int size()

Returns the number of documents contained in this folder.

Returns:

the number of documents

 public Enumeration files()

Returns an enumeration of all the documents contained in this folder. Use the Enumeration methods on the returned object to fetch the elements sequentially.

Returns:

an enumeration of the links

 public Select getCriteria()

returns the criteria defined for all documents in this folder.

Returns:

a Select object specifying criteria

 public Vector categories()

returns a vector of common categories defined for all documents in this folder.

Returns:

a vector of categories

 public String getCategories()

Returns the common document categories as a string with categories separated by spaces. This method is accessible from JavaScript.

Returns:

a string of categories separated by spaces

 public boolean setCategories(String categories)

Sets the common categories. Each term in the specified categories string is assigned as a common category to the folder. Any previously specified categories are lost. This method is accessible from JavaScript.

Parameters:

categories - a string of categories separated by spaces

Returns:

true if each of the terms has no more than 20 characters; false otherwise

 public void setType(String type)

Sets the common document type.

Parameters:

type - a document type, one of TEXT, URL, PATH and PURSE

See Also:

TEXT, URL, PATH, PURSE

 public void setKeyword(String keyword)

Sets the common keyword.

Parameters:

a - keyword

 public void setExpansion(String expansion)

Sets the expansion link name.

Parameters:

one - of CONTAINS, FOLLOW_UP and NEXT_VERSION

 public void removeType()

Unsets the common document type.

 public void setCube(String area,
                     String time,
                     String type)

Sets the folder's project cube.

Parameters:

area - a project area

time - a project time

type - a project type

 public Header find(String title)

Returns the document in this folder with the specified title.

Parameters:

title - a documnet title

Returns:

a document or document header

 public boolean topLevel(Header file)

Tests if the specified document is a top level document in this folder. Top level documents are documents that do not belong or reply to any other document in the folder, nor have a next version in the folder.

Parameters:

file - a document or document header

Returns:

true if it is a top level document, false otherwise

 public void add(Header file)

Adds a document to this folder. The view vector is updated correspondingly.

Parameters:

file - a document or document header

 public void remove(Header file)

Removes a document from this folder. The view vector is updated correspondingly.

Parameters:

file - a document or document header

 public boolean equals(Object object)

Compares this object to the specified object. The result is true if and only if the argument is not null and is a Folder object that has the same cube and the same common categories defined.

Parameters:

object - the object to compare with

Returns:

true if the objects are the same; false otherwise

Overrides:

equals in class Object

 public void clear()

Removes all documents from this folder.

 public void put()

Stores all documents in this folder for later retrieval. Also stores the project cube with respect to each document.

See Also:

put, put, put

 public DataRequest retrieve(Boolean complete)

Creates a data request to retrieve all documents that belong to this folder. This method is accessible from JavaScript.

Parameters:

complete - a boolean to specify whether the complete documents or only the document headers should be retrieved

Returns:

a data request to retrieve a folder

 public DataRequest retrieve(boolean complete)

Creates a data request to retrieve all documents that belong to this folder.

Parameters:

complete - a boolean to specify whether the complete documents or only the document headers should be retrieved

Returns:

a data request to retrieve a folder

All Packages  Class Hierarchy  This Package  Previous  Next  Index