oracle.jdeveloper.model

Class ContentFolder

java.lang.Object

oracle.jdeveloper.model.ContentFolder

public class ContentFolder
extends java.lang.Object

This class is used to dipslay and edit a ContentSet in the UI.

Constructor Summary

Constructors

Constructor and Description
ContentFolder(java.net.URL contentFolderURL) Constructs a ContentFolder.
ContentFolder(java.net.URL contentFolderURL, PatternFilter[] filters) Constructs a ContentFolder where contentFolderURL is the URL of the content folder.
ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL) Creates a new ContentFolder.
ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL, PatternFilter[] filters) Creates a new ContentFolder.

Method Summary

Modifier and Type	Method and Description
void	addFilter(PatternFilter patternFilter) Adds the supplied filter to the list of filters for this content folder.
void	addRelativeExcludeFilter(java.lang.String excludePattern) Adds an exclude PatternFilter with the supplied pattern.
void	addRelativeIncludeFilter(java.lang.String includePattern) Adds an include PatternFilter with the supplied pattern.
boolean	equals(java.lang.Object object)
PatternFilter[]	getAllFilters() Returns the filters for this content folder.
java.net.URL	getContentFolderURL() Gets the URL for the content folder.
PatternFilter	getPrimaryIncludeFilter() Gets the PatternFilter that defines the default inclusion pattern for this ContentFolder.
java.net.URL	getRootURL() Gets the root URL for this content folder.
void	setIncludeSubfolders(boolean include) Specifies whether or not subfolders are included.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentFolder

public ContentFolder(java.net.URL contentFolderURL)

Constructs a ContentFolder. The contentFolderURL is the URL of the content folder.

Note: For Java content sets, if the content folder is a subfolder undera source root, you must also specify the URL for the source root. In this case, use ContentFolder(URL, URL) or ContentFolder(URL, URL, PatternFilter[]).

Parameters:

contentFolderURL - the content folder URL

See Also:

ContentFolder(URL, URL), ContentFolder(URL, PatternFilter[]), ContentFolder(URL, URL, PatternFilter[])

ContentFolder

public ContentFolder(java.net.URL contentFolderURL,
                     PatternFilter[] filters)

Constructs a ContentFolder where contentFolderURL is the URL of the content folder. The supplied filters should be those associated with the content folder in the ContentSet.

Note: For Java content sets, if the content folder is a subfolder undera source root, you must also specify the URL for the source root. In this case, use ContentFolder(URL, URL).

Parameters:

contentFolderURL - the content folder URL

filters - the pattern filters assoicated with this URL, or null.

See Also:

ContentFolder(URL), ContentFolder(URL, URL), ContentFolder(URL, URL, PatternFilter[])

ContentFolder

public ContentFolder(java.net.URL contentFolderURL,
                     java.net.URL srcRootURL)

Creates a new ContentFolder. This constructor is especially useful for Java ContentSets which must have a source root, and optiontionally, might have a content folder which is a subfolder of that root.

The srcRootURL can be null, in which case it is assumed that the supplied contentFolderURL is the source root. Otherwise, contentFolderURL must be a subfolder under srcRootURL.

Parameters:

contentFolderURL - the content folder URL

srcRootURL - the source root for the content, or null if contentFolderURL is also the source root

Throws:

java.lang.IllegalArgumentException - If the contentFolderURL is not under the srcRootURL.

See Also:

ContentFolder(URL), ContentFolder(URL, PatternFilter[]), ContentFolder(URL, URL, PatternFilter[])

ContentFolder

public ContentFolder(java.net.URL contentFolderURL,
                     java.net.URL srcRootURL,
                     PatternFilter[] filters)

Creates a new ContentFolder. This constructor is especially useful for Java ContentSets which must have a source root, and optiontionally, might have a content folder which is a subfolder of that root.

The srcRootURL can be null, in which case it is assumed that the supplied contentFolderURL is the source root. Otherwise, contentFolderURL must be a subfolder under srcRootURL.

Parameters:

contentFolderURL - the content folder URL

srcRootURL - the source root for the content, or null if contentFolderURL is also the source root

filters - the pattern filters assoicated with this URL, or null

Throws:

java.lang.IllegalArgumentException - If the contentFolderURL is not under the srcRootURL.

See Also:

ContentFolder(URL), ContentFolder(URL, URL), ContentFolder(URL, PatternFilter[])

Method Detail

getPrimaryIncludeFilter

public PatternFilter getPrimaryIncludeFilter()

Gets the PatternFilter that defines the default inclusion pattern for this ContentFolder. For ContentFolders where the source root is the content folder, this will return an include-all filter. Otherwise, it will return an include for the subfolder relative to the root.

Returns:

addRelativeExcludeFilter

public void addRelativeExcludeFilter(java.lang.String excludePattern)

Adds an exclude PatternFilter with the supplied pattern.

Parameters:

excludePattern - the pattern for the PatternFilter

See Also:

PatternFilter

addFilter

public void addFilter(PatternFilter patternFilter)

Adds the supplied filter to the list of filters for this content folder.

Parameters:

patternFilter - the filter to add; patternFilter must not be null

addRelativeIncludeFilter

public void addRelativeIncludeFilter(java.lang.String includePattern)

Adds an include PatternFilter with the supplied pattern.

Parameters:

includePattern - the pattern for the PatternFilter

See Also:

PatternFilter

getRootURL

public java.net.URL getRootURL()

Gets the root URL for this content folder. For Java content sets, the root URL is the source root, for all others, it is the URL of the content folder.

Returns:

the root URL for this content folder

See Also:

getContentFolderURL()

getContentFolderURL

public java.net.URL getContentFolderURL()

Gets the URL for the content folder.

Returns:

the URL for the folder that contains content

See Also:

getRootURL()

setIncludeSubfolders

public void setIncludeSubfolders(boolean include)

Specifies whether or not subfolders are included.

Parameters:

include - use true to include subfolders

getAllFilters

public PatternFilter[] getAllFilters()

Returns the filters for this content folder.

Returns:

an array of PatternFilters.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object