Chapter 4. Reference

4.1. Preferences

Use the Window - Preferences dialog pages to set how you want Web Image Collector to operate.

You can browse the Preferences dialog pages by looking through all the titles in the left pane or search a smaller set of titles by using the filter field at the top of the left pane. The results returned by the filter will match both Preference page titles and keywords such as "appearance" and "java". However, to find specific functions you may have to search the online help instead.

The arrow controls in the upper-right of the right pane enable you to navigate through previously viewed pages. To return to a page after viewing several pages, click the drop-down arrow to display a list of your recently viewed preference pages

4.1.1. General

General settings for the Workbench. The term Workbench refers to the desktop development environment.

Each Workbench window contains one or more perspectives. Perspectives contain views and editors and control what appears in certain menus and tool bars. More than one Workbench window can exist on the desktop at any given time.

Table 4.1. General Preferences

OptionDescription
Always run in backgroundTurn this option on to perform long running operations in the background without blocking you from doing other work.
Keep next/previous part dialog open If this option is turned on then the editor and view cycle dialogs will remain open when their activation key is let go. Normally the dialog closes as soon as the key combination is release.
Show Heap StatusTurn this option on to display an indicator showing information about current Java heap usage.
Open mode...You can select one of the following methods for opening resources:
  • Double click - Single clicking on a resource will select it and double clicking on it will open it in an editor.

  • Single click (Select on hover) - Hovering the mouse cursor over the resource will select it and clicking on it once will open it in an editor.

  • Single click (Open when using arrow keys) - Selecting a resource with the arrow keys will open it in an editor.

Note: Depending on which view has focus, selecting and opening a resource may have different behavior.


4.1.1.1. Appearance

This preference page is used to set preferences for the look and layout of views in the workbench.

Table 4.2. Appearance Preferences

OptionDescription
Current presentationSpecify the currently active presentation (look and feel).
Override presentation settingsLocally override the settings from the current presentation's defaults.
Editor tab positionsSpecify either top or bottom to indicate where you want tabs for stacked editors to appear.
View tab positionsSpecify either top or bottom to indicate where you want tabs for stacked views to appear.
Perspective switcher positionsSpecify the location of the perspective switcher bar.
Current themeSpecify the currently active theme (color and font set).
Show text on perspective barSpecify whether labels should be shown in the perspective bar as well as icons.
Show traditional style tabsSpecify whether traditional (square) tabs should be used in place of the curved tabs.
Enable animationsEnable/disable the feature where views animate to their location when closed or opened.

4.1.1.2. Perspectives

Allows you to set the state of existing perspectives.

Table 4.3. Perspectives Preferences

OptionDescription
Open a new perspectiveUse this option to set what happens when you open a new perspective. Do you want the perspective opened within the current Workbench window or opened in a new window?
Open a new viewUse this option to specify what happens when a new view is opened. It is either opened to its default position within the current perspective or it is opened as a fast view and docked to the side of the current perspective.
Hide empty fast view barUse this option to specify visibility of an empty fast view bar. If this preference is set and the current perspective doesn't contain any fast views, the fast view bar becomes invisible.
New project optionsUse this option to specify the perspective behavior when a new project is created. You can set it to switch the current perspective to be the one associated with the project type and open the perspective in the same Workbench window as the current one, switch the perspective and open it in a new Workbench window, or not to switch perspectives at all.

4.1.2. Help

Use this preference page to control where help is opened, as well as searching behavior.

Table 4.4. Help Preferences

OptionDescription
Open Help SearchConfigures whether Help/Search (and Help/Index if configured) opens the help view or help contents.
Open help view documentsThis option allows you to determine whether the documents selected in the help view will be opened in-place, in the editor area or in a browser.
Open Help ContentsAllows you to open help contents in an external web browser or in the Eclipse help browser. Use "Web Browser" preference page to select browser to use.
Open window context help This option allows you to determine whether the window context help will be opened in a dynamic help view or in an infopop.
Open dialog context helpThis option allows you to determine whether the dialog context help will be opened in a dynamic help section of help view or in an infopop.

4.1.2.1. Help Content

Use this preference page to configure help to download help content from a remote server (an information center).

Table 4.5. Help Content Preferences

OptionDescription
Include local help onlyRemote help content is not enabled.
Include remote help and give local help priorityThe help system will show locally installed help contents as well as help contents from the information centers specified in the table. If the same page exists both locally and on the remote information center the local page will be shown.
Include remote help and give it priorityThe help system will show locally installed help contents as well as help contents from the information centers specified in the table. If the same page exists both locally and on the remote information center the remote page will be shown.
New/Edit/DeleteAdd, edit or delete a remote data source
View PropertiesView the properties for this remote data source
Test ConnectionTests to see if it is possible to connect to this host/port combination
Disable/EnableAllows a data source to be disabled so the help system will not try to read topics from that source.

4.1.3. Install

This page allows you to configure general install/update preferences.

Table 4.6. Install Preferences

OptionDescription
Browsing for updatesThis option allows you to configure what software versions are shown in the Available Updates wizard. You can select to show only the latest version of an update, or all versions of updates that are available.
When software selected for an install wizard may not be compatibleThis preference allows you to configure how incompatibilities are reported. If you attempt to update, uninstall, or install software that is not compatible with the software you already have installed, you can elect to open a wizard to edit your software selections, or you can just have the problem reported in the error log without opening the wizard. By default you will be prompted about what you want to do in this situation.

4.1.3.1. Automatic Updates

This page allows you to configure the preferences for automatic updates.

Table 4.7. Automatic Updates Preferences

OptionDescription
Automatically find new updates and notify meWhen selected, Update manager will automatically search for update, as defined by the update schedule
Update ScheduleLook for updates on each startup, or once a day or some day a week, at a predefined time.
Download OptionsThis option allows you to choose between having Eclipse search for updates and notifying you of them once they are available or having Eclipse automatically download new updates and asking you to install them.
When updates are foundChoose to be notified about new updates only once, or to receive reminders until the updates are installed.

4.1.3.2. Available Software Sites

This page allows you to add and remove software sites, or select the sites that should be consulted whenever you install new software or update your installation.

Table 4.8. Available Software Preferences

OptionDescription
Add/Edit/RemoveAdd, edit or remove a software site.
Test ConnectionTests to see if it is possible to connect to the selected software site.
Disable/EnableAllows a software site to be disabled so that the update system will not try to find software on the site when updating or installing software.
Import/ExportImport or export the list of software sites from a file.

4.1.4. License Manager

The license manager shows all the current licenses found in your product. Use the license manager to activate, release, and purchase new licenses.

Table 4.9. License Manager Preferences

OptionDescription
ActivateActivates the selected license.
ReleaseReleases the selected license.

4.2. Projects

Projects are a way to organize image collections based on how and where they are downloaded from. Projects can be exported and shared with friends or backed up to other locations.

4.2.1. Basic Newsgroup

The Basic Newsgroup project will create a new image collection based on one newsgroup server. The newsgroup server may have any number of groups and you can select which groups to add to the project.

4.2.1.1. Create a new Project

The following lists the pages used when creating a new basic newsgroup project.

Newsgroup Server Login : Section 4.3.1.1, “Newsgroup Server Login”

Groups To Search : Section 4.3.1.2, “Groups To Search”

File and Image Size : Section 4.3.1.3, “File and Image Size”

Name the project : Section 4.3.1.4, “Name the Project”

4.2.1.2. Edit Project Properties

The following lists the pages used when editing a basic newsgroup project.

Author Filters : Section 4.3.2.1, “Author Filter”

Connections : Section 4.3.2.2, “Connections”

File Filters : Section 4.3.2.3, “File Filters”

Image Files : Section 4.3.2.4, “Image Files”

Image Sizes : Section 4.3.2.5, “Image Sizes”

Groups : Section 4.3.2.6, “Groups”

Server : Section 4.3.2.7, “Server”

Subject Filters : Section 4.3.2.8, “Subject Filter”

4.3. Project Settings

Projects settings

4.3.1. New Project Settings

New project settings are a part of creating a new image collection. These settings let you tune the search process to include or exclude images based on a variety of options. When creating a new project, you will be presented with a selective amount of settings. To see all settings available, use the project properties after the project is created.

4.3.1.1. Newsgroup Server Login

These settings are for specifying the newsgroup server to download images from.

Table 4.10. Newsgroup Server Login Settings

OptionDescription
Newsgroup Server This is the newsgroup server host name. This can be either an IP address like 192.168.0.1 or a name of a newsgroup server such as news.giganews.com.
Select button This button will open the host selection dialog box which has a list of free and paid newsgroup servers. Select a newsgroup server from this list if you do not have your own newsgroup server to use.
Login Credentials If you have an account with the newsgroup server, you will need to enter your username and password here. Otherwise leave the anonymous login checked.

4.3.1.2. Groups To Search

These settings are for specifying the news groups to download images from.

Table 4.11. Groups Settings

OptionDescription
GroupsThese are the newsgroups available on the server. Click the check box next to each group to download images from.
RefreshThis button will replace the currently listed groups with a fresh list of groups from the server.
Select AllThis button will check all check boxes for each group shown in the list.
Unelect AllThis button will uncheck all check boxes for each group shown in the list.
Find This button will locate the a group in the list that contains the text entered in the text field. Additional clicks of this button will move to the next match in the list.
Filter This button will remove all groups from the list except those that contain the text entered in the text field. Click the refresh button to restore the full group listing.
Clear This button will remove any filter if one is applied.

4.3.1.3. File and Image Size

These settings set restrictions on the image width, height, and file size.

Table 4.12. File and Image Size Settings

OptionDescription
Image minimum size

You can specify a minimum width, height, both or none. For example if you set a minimum width of 50 and a minimum height of 50, all images smaller than 50x50 are skipped. You can leave the height unchecked and just specify a minimum width of 50 so that an image of 60x10 is downloaded. If you leave both width and height fields unchecked, this filter is disabled.

  • Width - This is the smallest allowable image width in pixels. Images with a width smaller than the number here will not be added to the image collection.

  • Height - This is the smallest allowable image height in pixels. Images with a height smaller than the number here will not be added to the image collection.

Image maximum size

You can specify a maximum width, height, both or none. For example if you set a maximum width of 500 and a maximum height of 500, all images larger than 500x500 are skipped. You can leave the height field unchecked and just specify a maximum width of 500 so that an image of 60x600 is downloaded. If you leave both width and height fields unchecked, this filter is disabled.

  • Width - This is the largest allowable image width in pixels. Images with a width larger than the number here will not be added to the image collection.

  • Height - This is the largest allowable image height in pixels. Images with a height larger than the number here will not be added to the image collection.

File size filter

This option allows you to set a minimum and or a maximum file size in kilobytes (KB). When images are downloading, they are compared to these options and if the file size does not meet the minimum or maximum settings, the image will not be added to the image collection.

  • Minimum size - This is the smallest allowable file size in KB. Images smaller than the number here will not download. If this field is unchecked, this option is ignored.

  • Maximum size - This is the largest allowable size in KB. Images larger than the number here will not download. If this field is unchecked, this option is ignored.


4.3.1.4. Name the Project

This is where you name the project before it is created. By default the project will save to your workspace location, however you can change this and save the project wherever you like.

Table 4.13. Name the Project Settings

OptionDescription
Project nameThe name of the project.
Use default locationThis option lets you change the default location of the project.

4.3.2. Edit Project Properties

All projects have settings that are configured when a project is created. These are called project properties and they can be changed by launching the project properties dialog.

To edit a project

  • Select the project in one of the navigation views.

  • Click Properties on the pop-up menu.

4.3.2.1. Author Filter

These settings are for specifying the filter of including and excluding articles and their image content by matching keywords or regular expressions (regex) against the article author.

The author is the person who posts a newsgroup article and image to the server. Sometimes you may want to skip images posted by certain authors to avoid junk images. Sometimes you may want to download only images posted by certain authors. When a keyword or regex in the list matches an article author, that article's image is either downloaded or skipped depending on this filter's mode.

Table 4.14. Author Filter Settings

OptionDescription
Author Filter This is the list containing the keywords or regex values to compare against article authors.
Mode
  • Disable - This option will disable the author filter without the need to remove entries from the list.

  • Include listed items - This option will include all articles that contain one or more items in the list. This option results in a very limited set of results.

  • Exclude listed items - This option will exclude all articles that contain one or more items in the list. This option results in a clean and more specific set of results.


4.3.2.1.1. Keyword filter example

For example, assume that you have

	
					'Exclude all listed items'
					An entry: jake@allspam.com
					An entry: @cnn.com
					An entry: puppies
				

The following articles would be processed:

	
					From: jake@nospam.com
					From: bob@photos.net
				

The following articles would be skipped:

	
					From: jake@allspam.com
					From: bob@cnn.com
					From: poster@cnn.com
					From: dogs@puppies.com
					From: dogs@puppies.org
				
4.3.2.1.2. Regex filter example

Regular expressions (regex) are special text that describes a pattern to match within text or in this case within the article poster's name.

For example, assume that you have

	
					^[\w\.=-]+@[\w\.-]+\.[\w]{2,3}$
				

This regex pattern will match all properly formed email addresses. The following articles with the authors would be included:

	
					From: bob@cnn.com
					From: joey@imagedump.com
				

The following articles with authors would be excluded:

	
					From: Somebody
				

4.3.2.2. Connections

These settings control the behaviour of connections to newsgroup servers. Use these settings to control the connection timeouts and the number of simultaneous connections.

Table 4.15. Connection Settings

OptionDescription
Timeouts

This option is used for tuning the communication with newsgroup servers.

  • Connection timeout - This timeout is used when attempting to connection to a newsgroup server.

  • Read timeout - This timeout is used when downloading a file from a newsgroup server.

Connection pool

This option is used for controling how many connections can be active at the same time.

  • Core size - This is the base number of active connections.

  • Maximum size - This is the maximum number of active connections.


4.3.2.3. File Filters

These settings control image file storage to your computer.

Table 4.16. File Filters Settings

OptionDescription
Duplicate files

These settings are for processing duplicate images. An image is a duplicate if there is already an image of the same file name downloaded to the target folder.

  • Skip duplicate files - This option will skip (not download) duplicate images.

  • Overwrite duplicate files - This option will download and overwrite duplicate images.

  • Save duplicate files with a different name - This option will download and save the duplicate image with an index such as (1) or (2) in the filename.

File path naming options

This setting controls the naming of each image target folder within the project. Use this option to control how to group images as they are downloaded.

  • Group and author - This option will create a main folder with the newsgroup name, then a sub folder with the posting author.

  • Group and subject - This option will create a main folder with the newsgroup name, then a sub folder with the subject.

  • Author - This option will create a main folder with the posting author as the name.

  • Subject - This option will create a main folder with the posting subject as the name.

  • Group - This option will create a main folder with the posting group as the name.


4.3.2.4. Image Files

These settings control the filter of including or excluding images based on the file types and sizes.

Table 4.17. Image Files Settings

OptionDescription
File extension filter

This filter can ignore the listed file types or it can download only the listed file types.

  • Disable - This option will disable the filter without removing list entries.

  • Include listed items - This option will include all images that match any of the size items in the list. This option results in a very limited set of results.

  • Exclude listed items - This option will exclude all images that match any of the the list. This option results in a clean and more specific set of results.

File size filter

This option allows you to set a minimum and or a maximum file size in kilobytes (KB). When images are downloading, they are compared to these options and if the file size does not meet the minimum or maximum settings, the image will not be added to the image collection.

  • Minimum size - This is the smallest allowable file size in KB. Images smaller than the number here will not download. If this field is unchecked, this option is ignored.

  • Maximum size - This is the largest allowable size in KB. Images larger than the number here will not download. If this field is unchecked, this option is ignored.


4.3.2.5. Image Sizes

These settings control the filter of including or excluding images based on the width and height of the image. This page includes a size list for specific image dimensions to filter, and it includes a minimum and maximum dimension filter. As images are downloaded to your computer, they are compared to the settings on this page to determine if the images should be downloaded or skipped.

Table 4.18. Image Sizes Settings

OptionDescription
Image size filter

You can specify exact sizes of images to include or exclude in this filter. For example if you want to download only 800 x 600 and 1024 x 768 sized images, you can set an include filter with these two sizes.

  • Disable - This option will disable the image size filter without the need to remove entries from the list.

  • Height - This is the smallest allowable image height in pixels. Images with a height smaller than the number here will not be added to the image collection.

Image minimum size

You can specify a minimum width, height, both or none. For example if you set a minimum width of 50 and a minimum height of 50, all images smaller than 50x50 are skipped. You can leave the height unchecked and just specify a minimum width of 50 so that an image of 60x10 is downloaded. If you leave both width and height fields unchecked, this filter is disabled.

  • Width - This is the smallest allowable image width in pixels. Images with a width smaller than the number here will not be added to the image collection.

  • Height - This is the smallest allowable image height in pixels. Images with a height smaller than the number here will not be added to the image collection.

Image maximum size

You can specify a maximum width, height, both or none. For example if you set a maximum width of 500 and a maximum height of 500, all images larger than 500x500 are skipped. You can leave the height field unchecked and just specify a maximum width of 500 so that an image of 60x600 is downloaded. If you leave both width and height fields unchecked, this filter is disabled.

  • Width - This is the largest allowable image width in pixels. Images with a width larger than the number here will not be added to the image collection.

  • Height - This is the largest allowable image height in pixels. Images with a height larger than the number here will not be added to the image collection.


4.3.2.6. Groups

These settings are for specifying the news groups to download images from.

Table 4.19. Groups Settings

OptionDescription
GroupsThese are the newsgroups available on the server. Click the check box next to each group to download images from.
RefreshThis button will replace the currently listed groups with a fresh list of groups from the server.
Select AllThis button will check all check boxes for each group shown in the list.
Unelect AllThis button will uncheck all check boxes for each group shown in the list.
Find This button will locate the a group in the list that contains the text entered in the text field. Additional clicks of this button will move to the next match in the list.
Filter This button will remove all groups from the list except those that contain the text entered in the text field. Click the refresh button to restore the full group listing.
Clear This button will remove any filter if one is applied.

4.3.2.7. Server

These settings are for specifying the newsgroup server to download images from.

Table 4.20. Server Settings

OptionDescription
Newsgroup Server This is the newsgroup server host name. This can be either an IP address like 192.168.0.1 or a name of a newsgroup server such as news.giganews.com.
Select button This button will open the host selection dialog box which has a list of free and paid newsgroup servers. Select a newsgroup server from this list if you do not have your own newsgroup server to use.
Login Credentials If you have an account with the newsgroup server, you will need to enter your username and password here. Otherwise leave the anonymous login checked.

4.3.2.8. Subject Filter

These settings are for specifying the filter of including and excluding articles and their image content by matching keywords or regular expressions (regex) against the article subject.

Each article posted to a newsgroup server must have a subject just like an email message. Sometimes you may want to skip images posted with certain subject content to avoid junk images. Sometimes you may want to download only images posted with specific words in the subject. When a keyword or regex matches any article subject, that article's image is either downloaded or skipped.

Table 4.21. Subject Filter Settings

OptionDescription
Subject Filter This is the list containing the keywords or regex values to compare against article subjects.
Mode
  • Disable - This option will disable the subject filter without the need to remove entries from the list.

  • Include listed items - This option will include all articles that contain one or more items in the list. This option results in a very limited set of results.

  • Exclude listed items - This option will exclude all articles that contain one or more items in the list. This option results in a clean and more specific set of results.


4.3.2.8.1. Keyword filter example

For example, assume that you have

	
					'Exclude all listed items'
					An entry: kittens
					An entry: elephants
				

The following articles would be processed:

	
					Subject: Puppies for sale
					Subject: kitty cats
				

The following articles would be skipped:

	
					Subject: Kittens with machine guns
					Subject: Who let the elephant out?
				
4.3.2.8.2. Regex filter example

Regular expressions (regex) are special text that describes a pattern to match within text or in this case within the article poster's name.

For example, assume that you have

	
					pupp(y|ies)
				

The following articles with the subjects would be included:

	
					Subject: A new set of puppies
					Subject: My furry little puppy is so cute
				

Notice the case sensitivity in the regex. The following articles would be excluded:

	
					Subject: Puppies are cool
					Subject: WHERE IS MY PUPPY YO?
				

4.3.2.9. Completion Tasks

These settings are used to perform optional tasks when the project collection process is complete.

Table 4.22. Completion Task Settings

OptionDescription
Enable completion tasks

These options control if the completion tasks will execute and when.

  • Enabled for stop conditions - This option will enable the completion tasks to execute when any of the conditions in the stop conditions settings are met.

  • Enabled for manual stop - This option will enable the completion tasks to execute when you click the stop collecting button.

  • Enabled when all URLs are processed - This option will enable the completion tasks to execute when all URLs are searched and the collection process ends.

Execute command

This command can be executed as a completion task. You must include the full path of the program to execute and any arguments needed to execute. Leave the field empty to disable the execute command.

Execute action

These additional actions controntrol the program and your computer.

  • None - This option do nothing as an execute action.

  • Exit Newsgroup Image Collector - This option will close Newsgroup Image Collector.

  • Shutdown computer - This option will shutdown your computer. Your user account must have administrator rights on Windows, Mac, and Linux in order to successfully shut down your computer.


4.3.2.10. Stop Conditions

These settings are used to automatically terminate the collection process of the project. In many cases the collection process can run for a long time resulting in unknown results. Use this feature to control the collection process and limit the download results.

Table 4.23. Stop Condition Settings

OptionDescription
Number of downloaded files

This option will stop the collection process when the specified number of files are downloaded. If any files are currently downloading when the number of files are reached, they will continue to download.

Size of downloaded files

This option will stop the collection process when the specified total size of files are downloaded. If any files are currently downloading when the total size of files are reached, they will continue to download.

Finish downloading time

This option will stop the collection process based on total duration or clock time.

  • Disable feature - This option will disable the finish downloading time feature.

  • Stop downloading after total minutes - This option will stop the collection process when the total number of minutes have passed.

  • Stop downloading at - This option will stop the collection process when the system time reaches the specified time.