Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions developers/Clients/ImportLibrary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@ for building import clients. Several are provided by the OMERO team
directly:

- The integrated :doc:`/users/client-tutorials/insight/insight-import` importer
- The :doc:`/users/command-line-import` tool
- :doc:`/users/command-line-import` tool

Components
----------

The primary classes which make up the Import Library are:

- :source:` ImportLibrary.java <components/blitz/src/ome/formats/importer/ImportLibrary.java>`,
- :source:`ImportLibrary.java <components/blitz/src/ome/formats/importer/ImportLibrary.java>`
itself, which is the main driver
- :source:` ImportCandidates.java <components/blitz/src/ome/formats/importer/ImportCandidates.java>`
- :source:`ImportCandidates.java <components/blitz/src/ome/formats/importer/ImportCandidates.java>`
which takes file paths and determines the proper files to import
- :source:` ImportConfig.java <components/blitz/src/ome/formats/importer/ImportConfig.java>`,
- :source:`ImportConfig.java <components/blitz/src/ome/formats/importer/ImportConfig.java>`,
an extensible mechanism for storing the
- :source:` ImportEvent.java <components/blitz/src/ome/formats/importer/ImportEvent.java>`,
- :source:`ImportEvent.java <components/blitz/src/ome/formats/importer/ImportEvent.java>`,
the various events raised during import to ``IObserver``\ and
``IObservable`` implementations
- :source:` OMEROMetadataStoreClient.java <components/blitz/src/ome/formats/OMEROMetadataStoreClient.java>`,
- :source:`OMEROMetadataStoreClient.java <components/blitz/src/ome/formats/OMEROMetadataStoreClient.java>`,
the low-level connection to the server
- :source:` OMEROWrapper.java <components/blitz/src/ome/formats/importer/OMEROWrapper.java>`,
- :source:`OMEROWrapper.java <components/blitz/src/ome/formats/importer/OMEROWrapper.java>`,
the OMERO adapter for the Bio-Formats ``ImageReaders`` class
- In OMERO.insight, the main entry point is the importImage method of
:source:` OMEROGateway.java <components/insight/SRC/org/openmicroscopy/shoola/env/data/OMEROGateway.java>`.
:source:`OMEROGateway.java <components/insight/SRC/org/openmicroscopy/shoola/env/data/OMEROGateway.java>`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if you meant to end with a period on only the penultimate and final; perhaps this one used to be the final

- In the CLI, the main entry point is the
:source:` CommandLineImporter <components/blitz/src/ome/formats/importer/cli/CommandLineImporter.java>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space to elide here too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is fixed on dev_4_4 on #243 so will be sorted on develop once this is merged and I can rebase it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem, I'll just note thoughts as I see them, but as this is a rebase it'll probably still end up good to merge. (-:

class.
Expand Down
15 changes: 8 additions & 7 deletions developers/Cpp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ are considered:
Zip files containing the C++ header files, the libraries, and source
code are placed under OMERO\_HOME/target with other zip artifacts.

.. note::
If you are using make, you can unpack the main zip (e.g.
``OMERO.cpp-<version>-64dbg.zip``) to some directory
(``OMERO_DIST``) and follow the instructions below get started. For
Expand All @@ -151,31 +152,31 @@ the mentioned directories above. A simple `GNU make
:language: make
:linenos:

A trivial example: ``yourcode.cpp``
-----------------------------------
A trivial example: yourcode.cpp
-------------------------------

And a simple example file might looking something like the following:

.. literalinclude:: ../examples/omerocpp/yourcode.cpp
:language: c++
:linenos:

This code doesn't do much. It creates a server session, loads a few
This code does not do much. It creates a server session, loads a few
services, and prints the user's name. For serious examples, see
|OmeroClients|.

Compiling and running ``yourcode``
----------------------------------
Compiling and running yourcode
------------------------------

Therefore, to compile and run ``yourcode``, you'll need to download the
Therefore, to compile and run ``yourcode``, you will need to download the
two files above (Makefile and yourcode.cpp) and then from the shell:

::

make OMERO_DIST=dist yourcode
LD_LIBRARY_PATH=dist/lib ./yourcode --Ice.Config=dist/etc/ice.config

where you've edited ``dist/etc/ice.config`` to contain the values:
where you have edited ``dist/etc/ice.config`` to contain the values:

::

Expand Down
52 changes: 24 additions & 28 deletions developers/GettingStarted/AdvancedClientDevelopment.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
Developing OMERO clients
========================

:note:
.. note::

- If you are only interested in **using** our OMERO clients, please
see the :doc:`/users/clients-overview` section, which
will point you to user guides, demo videos, and download sites.
- If you are only interested in **using** our OMERO clients, please
see the :doc:`/users/clients-overview` section, which
will point you to user guides, demo videos, and download sites.

- This page is intended for developers already familiar with
client/server programming. If you are not, **your best starting
point is to read the**
:zeroc:`Hello World <doc/Ice-3.3.0/manual/Hello.html#22064>`
**chapter of the Ice manual (or more)**. A deeper understanding of
Ice might not be necessary, but certainly understanding the Ice
basics will make reading this guide **much** easier.
- This page is intended for developers already familiar with
client/server programming. If you are not, **your best starting
point is to read the**
:zeroc:`Hello World <doc/Ice-3.3.0/manual/Hello.html#22064>`
**chapter of the Ice manual (or more)**. A deeper understanding of
Ice might not be necessary, but certainly understanding the Ice
basics will make reading this guide **much** easier.

--------------

For developers, there are many examples listed below, all of which are
stored under: :sourcedir:`examples` and
Expand Down Expand Up @@ -43,7 +42,6 @@ behind the scenes more transparent, but is not necessary. The points
below outline all that an application writer is expected to know with
links to further information where necessary.

--------------

Distributed computing
---------------------
Expand Down Expand Up @@ -1179,9 +1177,10 @@ Example: :source:`examples/OmeroClients/smartpointers.cpp`

# No java example

**Warning**: As shown in the example, using a smart pointer instance in
a boolean or integer/long context, returns 1 for true (i.e. non-null) or
0 for false (i.e. null). Be especially careful with the RTypes.
.. Warning::
As shown in the example, using a smart pointer instance in
a boolean or integer/long context, returns 1 for true (i.e. non-null) or
0 for false (i.e. null). Be especially careful with the RTypes.

For more information, see :zeroc:`6.14.6 Smart Pointers for
Classes <doc/Ice-3.3.0/manual/Cpp.7.14.html>` in the
Expand Down Expand Up @@ -1240,8 +1239,8 @@ Example: :source:`examples/OmeroClients/clientpointer.cpp`

# No java example

``__getattr__`` & ``__setattr__`` (Python only)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
__getattr__ and __setattr__ (Python only)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Like smart pointers for |OmeroCpp|, the |OmeroPy| SDK defines ``__getattr__`` and
``__setattr__`` methods for all |OmeroModel|
Expand Down Expand Up @@ -1322,7 +1321,6 @@ method beginning with an underscore or with ``ice_``. For example,
ice_type
>>>

--------------

Services overview
-----------------
Expand Down Expand Up @@ -1801,13 +1799,12 @@ and may be under layers of application code. But when designing where
active ``omero.client`` objects are kept, be sure that your clean-up
code takes care of them.

--------------

IQuery
------

Now that we've gotten a good idea of the basics, it might be interesting
to start asking the server what it's got. The most powerful way of doing
Now that we have a good idea of the basics, it might be interesting
to start asking the server what it has got. The most powerful way of doing
this is by using IQuery and the Hibernate Query Language (HQL).

::
Expand Down Expand Up @@ -1904,12 +1901,11 @@ get a list of ``IObject`` instances back. They are guaranteed to be of
type ``omero::model::Image``, but you may have to cast them to make full
use of that information.

--------------

IUpdate
-------

After you've successfully read objects, an obvious thing to do is create
After you have successfully read objects, an obvious thing to do is create
your own. Below is a simple example of creating an image object:

::
Expand Down Expand Up @@ -1994,12 +1990,12 @@ Example: :source:`examples/OmeroClients/updates.py`

Example: :source:`examples/OmeroClients/updates.java`

--------------


Examples
--------

To tie together some of the topics which we've outlined above, we would
To tie together some of the topics which we have outlined above, we would
like to eventually have several more or less complete application
examples which you can use to get started. For the moment, there is just
one simpler example ``TreeList``, but more will certainly be added. Let
Expand Down Expand Up @@ -2219,7 +2215,7 @@ Proposed
- Submitting a job
- Submitting a script

--------------


Advanced topics
---------------
Expand Down Expand Up @@ -2699,7 +2695,7 @@ Helper classes

Several types are harder to use than they need be. omero.sys.Parameters,
for example, is a class for which native implementations are quite
helpful. We've provided omero.sys.ParametersI in all supported
helpful. We have provided omero.sys.ParametersI in all supported
languages, and will most likely support more over time:

Other
Expand Down
2 changes: 1 addition & 1 deletion developers/Insight/ImplementationView.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The ``env`` package is also broken down into further sub-packages:

.. note::

Two extra packages are part of the project for convenience reason only:
Two extra packages are part of the project for convenience reason only:

- ``svc``: Provides general services e.g. transport service using *HTTP*.
- ``util``: Collection of classes that be used outside the OMERO structure
8 changes: 4 additions & 4 deletions developers/Java.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ for :doc:`/developers/server-blitz`.

The library is placed under OMERO\_HOME/dist/lib/client by the build,
or is alternatively available from Jenkins :omerojob:`here
<lastSuccessfulBuild/>`. To use |OmeroJava|, setup you'll
<lastSuccessfulBuild/>`. To use |OmeroJava|, setup you will
need to setup your CLASSPATH:

::
Expand All @@ -26,7 +26,7 @@ Extended classpath
------------------

To access all the functionality available in omero\_client.jar or to
use the importer, you'll of course need more jar files. To see all the
use the importer, you will need more jar files. To see all the
current requirements, take a look at the builds on :jenkins:`jenkins
<>`, or alternatively examine the
dependencies in the ivy.xml files (e.g.
Expand Down Expand Up @@ -461,7 +461,7 @@ created:

//now we have an original File in the database and raw data uploaded.
// We now need to link the Original file to the image using
// the File annotation object. That's the way to do it.
// the File annotation object. This is the way to do it.
FileAnnotation fa = new FileAnnotationI();
fa.setFile(originalFile);
fa.setDescription(omero.rtypes.rstring(description));
Expand Down Expand Up @@ -722,7 +722,7 @@ to an image.
Delete data
-----------

It is possible to delete Projects, datasets, images, ROIs etc and
It is possible to delete Projects, datasets, images, ROIs etc. and
objects linked to them depending on the specified options (see
:doc:`/developers/Modules/Delete`).

Expand Down
8 changes: 4 additions & 4 deletions developers/Matlab.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
OMERO Matlab language bindings
==============================

See |DevelopingOmeroClients| and |OmeroModel|, for an introduction about
See |DevelopingOmeroClients| and |OmeroModel|, for an introduction to
**Object**.

Installing and configuring
Expand Down Expand Up @@ -192,7 +192,7 @@ Read data
~~~~~~~~~

The ``IContainer`` service provides method to load the data management
hierarchy in OMERO -- Projects, Datasets, Etc. A list of examples
hierarchy in OMERO -- Projects, Datasets, etc. A list of examples
follows, indicating how to load Project, Dataset, Screen, etc.

- **Retrieve the projects owned by the user currently logged in.**
Expand Down Expand Up @@ -736,7 +736,7 @@ to an image.
Delete data
~~~~~~~~~~~

It is possible to delete Projects, Datasets, Images, ROIs etc and
It is possible to delete Projects, Datasets, Images, ROIs etc. and
objects linked to them depending on the specified options (see
:doc:`/developers/Modules/Delete`).

Expand Down Expand Up @@ -845,7 +845,7 @@ Create Image
~~~~~~~~~~~~

The following example shows how to create an Image from an Image already
in OMERO. Similar approach can be applied when uploading an image.
in OMERO. Similar approach can be applied when uploading an Image.

::

Expand Down
Loading