Students explored a number of online platforms throughout the duration of this module. The following are the platforms they used for their final projects.
Digital platforms
The Internet Archive is the largest archive of public domain resources online. Students used it both to source materials and to publish their own projects – making them available for free viewing and downloading as interactive EPUBs or PDFs.
ISSUU is a free (ad-supported) platform which supports online viewing and downloading of interactive PDFs.
YouTube is a widely used social media platform for video sharing. Students used it both as a source for relevant video material and as a publishing channel to share screencasts of their interactive digital editions.
Twitter is a widely used social media platform. Students used it to source material for some of their projects and worked with its native features (retweets, replies, and threads) to develop supplementary narratives to their main publishing channels.
Are.na is an independent alternative to mainstream social media platforms, popular among artists, designers and researchers. Students used it both for research and as a publishing platform, utilising its native features to structure materials as visual "blocks" sorted into "channels".
Print-on-demand platforms
Blurb is a popular print-on-demand platform. Blurb enables its users to upload pdf or epub files and distribute these as one-off printed publications. The production process is based on a model of shared profit and is free of cost to the publisher. Blurb is available within a few countries only.
Lulu provides a similar service to Blurb with some variations in the options to customise the printed edition. Unlike Blurb, it is available in over 200 countries worldwide.


Project Notes
Project: Pollen Viewer v3.2
Author: Phil Leduc
Company: Brown University
Description:
Improved Web version of the pollen
viewer featuring pollen lists
with latin and common names. Radio
buttons were replaced by a drop-down
selection window. Rewind and fast-forward
buttons were also added.
July 2002
Things to do...
- Create parameter file reader
- Incorporate new selection drop-down list


Xiaomi announces 108-megapixel Mi Note 10 for outside China
It’s a rebranded CC9 Pro
by Sam ByfordYesterday Xiaomi unveiled the CC9 Pro, the first phone to use the 108-megapixel image sensor the company co-developed with Samsung. The CC9 Pro won’t be sold outside of China, but today Xiaomi is announcing that a near-identical phone called the Mi Note 10 will.
The Mi Note 10 is being revealed in Spain today and will likely make it to the UK, other European countries, and India. There doesn’t appear to be any difference in the hardware, but as you’d expect the Note 10 will run MIUI atop Google-approved Android, with the CC9 Pro using Xiaomi’s own apps and services in China.
Xiaomi often gives its products different names and release schedules around the world — just look at the saga of the excellent but confusing Mi 9T/Redmi K20/Redmi K20 Pro/Mi 9T Pro lineup. This time the two phones are at least being announced within a day of each other.
Here are the key specs, as a reminder:
- Qualcomm Snapdragon 730G processor
- 6GB of RAM and 128GB of storage
- Five rear cameras: 108-megapixel f/1.69 wide, 12-megapixel f/2 2x telephoto, 5-megapixel f/2 5x telephoto, 20-megapixel f/2.2 ultrawide, and 2-megapixel macro
- 32-megapixel selfie camera
- 6.47-inch curved OLED screen with integrated fingerprint sensor
- 5,260mAh battery with 30W fast charger included
- USB-C and headphone jack
The Mi Note 10 won’t be quite as fast as flagships running a Snapdragon 855 — the Redmi K20 Pro included — but otherwise it sounds like a pretty compelling phone, and we’re certainly looking forward to checking out the camera. While the CC9 Pro starts at around $400 in China, the Mi Note 10 will be priced at 549 euros. It’s not clear exactly when and where the Mi Note 10 will be available, though.


Form Action
Dialog Action
Hide your fields in your dialog, but still post in the form.
Custom Action


This is a good time to sell a sports car, but the Jaguar F-Type is largely forgotten while everybody is fixated with the Toyota Supra right now. To reverse that, the British automaker wants to do a huge update to the iconic 2-seater, which could be ready by the end of next year.
The 2021 F-Type is somewhere between a brand new model and a refresh. It's based on the old car but has a new look on top. We've seen similar stuff with the Land Rover Discovery Sport recently. This way, Jaguar can save a few bucks and keep the attention-grabbing icon alive where many other automakers struggled.
However, the company may not be doing this completely alone. Thanks to a deep-rooted connection with the Germans, BMW engines may have been secured for this project and others like it. Initial reports talked about a bi-turbo 3-liter, like the one powering the M3, being installed. However, JLR now has an Ingenium inline-6, so the focus of the rumors has switched to a 4.4-liter V8.
It's no secret that the supercharged 5-liter powering many Range Rovers and the F-Type R or SVR has reached its full potential. Adding power is nearly impossible, and those pesky emissions regulators don't like it either.
We also can't forget the fact that 2-liter engines are now offered, and they will become mild-hybrids on this updated car. Cosmetic changes also create a futuristic look, starting at the front. Where the old headlights climb over the fenders, these ones are narrow, horizontal LED slits. The grille and nose are also lower, though our spyshots show two slight variations.
Around the rear, revisions are more modest, while the interior will sport the latest infotainment screen design, new buttons and who knows what else. Rumors talk about a plug-in or fully electric version arriving further down the line, but we suspect development money for this project is quite tight. 🏁


Why are there no Constitution based Dwarven Defender builds out there? I know there are some people here, including myself, that would love to see a Ftr10/DD30 build that is the juggernautiest of them all.
King Harbromm
probably because of the lack of offense. there are a few DD builds with decent CON scores (22 is the highest in recent memory), but going really high, to lets say 26 or 30, is usually not practical. your str (or dex) is low enough to make you fairly worthless in combat. and the high number of DWD levels needed to get a decent DR makes using other classes for offense difficult. over all, there are a number of great DWD builds, but they usually are not as popular nor as powerful as other characters with a few spells at their disposal.
that being said, if you have a build that doesn't nerf offense, than post it. you might just teach everyone the power of the DWD with a strong offence and defense.


| BEI SARS-CoV-2 Resources |
Information about SARS-CoV-2 strains and reagents. |
biomaterial |
| Bloom Lab: ACE-2 Binding affinities |
Deep Mutational Scanning of SARS-CoV-2 Receptor Binding Domain Reveals Constraints on Folding and ACE2 Binding
(Reference)
|
Experiemntal data on point mutations affecting receptor binding |
| Broad Terra cloud commons for pathogen surveillance |
The Broad Terra cloud workspace with COVID-19 genomics data and orkflows for genome assembly, quality control, metagenomic classification, and aggregate statistics. |
genomics |
| CDC SARS-CoV-2 Sequencing Resources |
rowd-sourced collection of information, documentation, protocols and other resources for public health laboratories intending to sequence SARS-CoV-2 samples. |
protocols |
| China National Center for Bioinformation's 2019 Novel Coronavirus Resource (2019nCoVR) |
A comprehensive resource on COVID-19, combining up-to-date information on all published sequences, mutation analyses, literatures and others. |
genomics, variant tracking, literature |
| Coronavirus 3D |
Web-based viewer for 3D visualization and analysis of the SARS-CoV-2 protein structures with respect to the CoV-2 mutational patterns |
protein structures |
| CoV-GLUE |
Amino acid variation database of amino acid replacements, insertions and deletions |
variant tracking |
| CoVariants |
SARS-CoV-2 variant tracking dashboard largely based on NEXTSTRAIN |
Multiple: phylogenomics, variant tracking |
| COVID-19 CoV Genetics Browser |
Track transmission, evolution, emergence, immune interactions, diagnostics, therapeutics & vaccines |
variant tracking |
| COVID-19 Genome Sequence Dataset on Registry of Open Data on AWS |
A centralized sequence repository for all strains of novel corona virus (SARS-CoV-2) submitted to NCBI. Included are both the original sequences submitted by the principal investigator as well as SRA-processed sequences that require the SRA Toolkit for analysis. |
genomics |
| CoVizu |
Near real-time visualization of hCoV-19 genomic variation |
|
| GISAID |
International database of hCoV-19 genome sequences and related clinical and epidemiological data |
genomics |
| GISAID variant tracking page |
GISAID's variant tracking dashboard |
Strains, map, graph, metadata, |
| Immune Epitope Database (IEDB) |
Experimental data on SARS-CoV-2 antibodies and T cell epitopes |
immunology |
| LANL COVID-19 Viral Genome Analysis |
Analyses and tools for exploring accruing mutations in SARS-CoV-2, geographically and over time, with an emphasis on the Spike protein. |
variant tracking |
| NCBI SARS-CoV-2 Resources |
SARS-CoV-2 related data and resources at NCBI, such as nucleotide and protein sequences from GenBank and RefSeq, genomic and metagenomic read sets in SRA, BLAST, PubMed, Clinical Trials. |
genomics, literature |
| NextClade |
Tool to perform clade assignment, mutation calling, and sequence quality checks/td>
| phylogenomics |
| Nextstrain COVID-19 genetic epidemiology |
Open-source SARS-CoV-2 genome data and analytic and visualization tools |
phylogenomics, variant tracking |
| Pango Lineages |
A dynamic nomenclature for SARS-CoV-2 lineages. Pangolin, a tool for global lineage assignment. |
phylogenomics, variant tracking |
| Reactome |
Open-source curated and peer-reviewed pathway database, including human coronavirus infection pathways. Tools for the visualization, interpretation and analysis of pathway knowledge to support basic research, genome analysis, modeling, systems biology and education. |
genomics, visualization |
| UCSC SARS-CoV-2 Genome Browser |
The UCSC SARS-CoV-2 genome browser and COVID-19 lung gene expression datasets. |
genome browser |
| UniProtKB SARS-CoV-2 |
SARS-CoV-2 proteins and annotations |
protein annotation |


{% extends "global/Page.html" %} {% load static otree %} {% block styles %} {% endblock %} {% block title %} Quiz {% endblock %} {% block content %}
Assume that there are goal of 222 energy tokens contributed to House Conservation Fund by the end of the experiment. You personally invested a total of 12 energy tokens over the 12 rounds, leaving 108 energy tokens in your private account. How much money will you receive at the end of the experiment for playing the game(excluding participation and quiz pay)?
{% next_button %}


Create Event
Create an Event
×
Find Restaurants
Find Workout
Get Exercises
Enter a city/town below for top 10 trending hotspots
City
State:
Get Restaurants
Today's Events
Menu of the Day
Enter Food Here
Search
Clear Results


Hopefully, if you’re reading this tutorial, you already know the importance of documenting your code.
When you write code, you write it for two primary audiences: your users and your developers (including yourself). Both audiences are equally important. If you’re like me, you’ve probably opened up old codebases and wondered to yourself, “What in
the world was I thinking?” If you’re having a problem reading your own code, imagine what your users or other developers are experiencing when they’re trying to use or contribute to your code.
Conversely, I’m sure you’ve run into a situation where you wanted to do something in Python and found what looks like a great library that can get the job done. However, when you start using the library, you look for examples, write-ups, or even
official documentation on how to do something specific and can’t immediately find the solution.
After searching, you come to realize that the documentation is lacking or even worse, missing entirely. This is a frustrating feeling that deters you from using the library, no matter how great or efficient the code is.
In this guide, you’ll learn from the ground up how to properly document your Python code from the smallest of scripts to the largest of Python projects to help prevent your users from ever feeling too frustrated to use or contribute to your project.
Documenting Using Docstrings
Now that we’ve learned about commenting, let’s take a deep dive into documenting a Python code base. In this section, you’ll learn about docstrings and how to use them for documentation. This section is further divided into the following sub-sections:
- Docstrings Background: A background on how docstrings work internally within Python
- Docstring Types: The various docstring “types” (function, class, class method, module, package, and script)
- Docstring Formats: The different docstring “formats” (Google, NumPy/SciPy, reStructured Text, and Epytext)
Docstrings Background
Documenting your Python code is all centered on docstrings. These are built-in strings that, when configured correctly, can help your users and yourself with your project’s documentation. Along with docstrings, Python also has the built-in function help() that prints out the objects docstring to the console. Here’s a quick example:
>>> help(str)
Help on class str in module builtins:
class str(object)
| str(object='') -> str
| str(bytes_or_buffer[, encoding[, errors]]) -> str
|
| Create a new string object from the given object. If encoding or
| errors are specified, then the object must expose a data buffer
| that will be decoded using the given encoding and error handler.
| Otherwise, returns the result of object.__str__() (if defined)
| or repr(object).
| encoding defaults to sys.getdefaultencoding().
| errors defaults to 'strict'.
# Truncated for readability
How is this output generated? Since everything in Python is an object, you can examine the directory of the object using the dir() command. Let’s do that and see what find:
>>> dir(str)
['__add__', ..., '__doc__', ..., 'zfill'] # Truncated for readability
Within that directory output, there’s an interesting property, __doc__. If you examine that property, you’ll discover this:
>>> print(str.__doc__)
str(object='') -> str
str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or
errors are specified, then the object must expose a data buffer
that will be decoded using the given encoding and error handler.
Otherwise, returns the result of object.__str__() (if defined)
or repr(object).
encoding defaults to sys.getdefaultencoding().
errors defaults to 'strict'.
Docstring Types
ocstring conventions are described within PEP 257. Their purpose is to provide your users with a brief overview of the object. They should be kept concise enough to be easy to maintain but still be elaborate enough for new users to understand their purpose and how to use the documented object.
In all cases, the docstrings should use the triple-double quote (""") string format. This should be done whether the docstring is multi-lined or not. At a bare minimum, a docstring should be a quick summary of whatever is it you’re describing and should be contained within a single line.
Class Docstrings
Class Docstrings are created for the class itself, as well as any class methods. The docstrings are placed immediately following the class or class method indented by one level.
Class docstrings should contain the following information:
- A brief summary of its purpose and behavior
- Any public methods, along with a brief description
- Any class properties (attributes)
- Anything related to the interface for subclassers, if the class is intended to be subclassed
Documenting Your Python Projects
Python projects come in all sorts of shapes, sizes, and purposes. The way you document your project should suit your specific situation. Keep in mind who the users of your project are going to be and adapt to their needs. Depending on the project type, certain aspects of documentation are recommended. The general layout of the project and its documentation should be as follows:
project_root/
│
├── project/ # Project source code
├── docs/
├── README
├── HOW_TO_CONTRIBUTE
├── CODE_OF_CONDUCT
├── examples.py
Projects can be generally subdivided into three major types: Private, Shared, and Public/Open Source.
Private Projects
Private projects are projects intended for personal use only and generally aren’t shared with other users or developers. Documentation can be pretty light on these types of projects. There are some recommended parts to add as needed:
- Readme: A brief summary of the project and its purpose. Include any special requirements for installation or operating the project.
- examples.py: A Python script file that gives simple examples of how to use the project.
Remember, even though private projects are intended for you personally, you are also considered a user. Think about anything that may be confusing to you down the road and make sure to capture those in either comments, docstrings, or the readme.
Shared Projects
Shared projects are projects in which you collaborate with a few other people in the development and/or use of the project. The “customer” or user of the project continues to be yourself and those limited few that use the project as well.
Documentation should be a little more rigorous than it needs to be for a private project, mainly to help onboard new members to the project or alert contributors/users of new changes to the project. Some of the recommended parts to add to the project are the following:
- Readme: A brief summary of the project and its purpose. Include any special requirements for installing or operating the project. Additionally, add any major changes since the previous version.
- examples.py: A Python script file that gives simple examples of how to use the projects.
- How to Contribute: This should include how new contributors to the project can start contributing.
The documentation of projects have a simple progression:
- No Documentation
- Some Documentation
- Complete Documentation
- Good Documentation
- Great Documentation
If you’re at a loss about where to go next with your documentation, look at where your project is now in relation to the progression above. Do you have any documentation? If not, then start there. If you have some documentation but are missing some of the key project files, get started by adding those.
In the end, don’t get discouraged or overwhelmed by the amount of work required for documenting code. Once you get started documenting your code, it becomes easier to keep going. Feel free to comment if you have questions or reach out to the Real Python Team on social media, and we’ll help.


Lawson Marlowe
Coding the Human Mind
About
Projects
Blog
Links
Projects
Dev Bootcamp
Apps/Games
Web Design


The page you requested doesn't seem to exist. You may wish to visit http://pipeglade.boundp.org You will be redirected there.


Preparation time
less than 30 mins
Cooking time
30 mins to 1 hour
Serves
Serves 6
Bring the fantastic flavours of the sea to your table with this luxurious recipe.
For the samphire, strip the fronds from the main stalks and wash thoroughly. Blanch the stalks in boiling water for 30 seconds. Refresh in cold water, drain and set aside.
Put the new potatoes in a large pan of salted water, bring to the boil and cook until just tender, then drain.
Meanwhile, heat a large frying pan over a high heat and add a little olive oil. Fry the shallots and garlic for a minutes then add the bacon and cook for a few minutes more. Add the potatoes, shaking the pan to make sure the potatoes are coloured all over. Add the samphire, broad beans and the butter.
Season with pepper, tossing thoroughly to make sure everything is heated through.
For the sea bass, preheat the grill to high. Line a baking tray with tin foil
Score the skin of the sea bass fillets being careful not to cut too deeply into the flesh.
Season the flesh side of the fish with salt and pepper. Arrange the fish skin-side up on the prepared tray. Brush the skin with olive oil, and place the fillets under the grill. Cook for about 4 minutes, or until the skin has blackened and the flesh is just cooked.
For the sauce, melt 50g/1¾oz of the butter in a saucepan over a medium heat, add the vegetables and fry gently until just softened but not coloured.
Add half the champagne and cook until reduced in volume to a syrupy consistency. Add the stock and cook until the volume of liquid has reduced by half. Add the cream and simmer to reduce by half.
Pass through a sieve into a clean saucepan and then over a low heat whisk in the remaining butter. Just before serving, stir in the shrimp and carefully warm the sauce until everything is heated through. Stir in the remaining champagne and check the seasoning.
To serve, put the new potatoes on a large serving plate. Top with the sea bass and pour over the sauce.


Shnergle: the world's first real-time reconnaissance platform
Shnergle was an easy-to-use, free iPhone app that allowed you to check out a place you were interested in visiting in near real-time to help you decide if you wanted to go.
Shnergle enabled people to capture, share and view location-based and time-stamped images, all whilst protecting personal privacy.
Unfortunately the service did not get the traction it needed to work, and could not commercially justify further investment, so we have taken the difficult choice to shut it down.
How did Shnergle work for consumers....
We tried to help venue owners and managers
Shnergle provided a real time engagement platform between merchants and the public. It acted as a simple marketing tool to help them tell the world what was happening in their establishment in real-time, thereby enabling the public to make highly-informed real-time decisions about where to go.
They could use it to:
• Generate business
• Better manage capacity, stock and staffing levels
In due course we were going to provide powerful analytics to
• Better understand what their customers wanted, and
• Accurately measure the effectiveness of their marketing activities
…all in real time.
We made a short video to explain the value...
It was featured in
How did the idea begin?
Jonny and Rob were out with friends in a bar in London one evening. Having finished dinner they were trying to decide what to do next - go for a drink elsewhere, or stay put as they already had a table? Jonny went for a quick "shnergle" around the pubs and bars nearby and reported back to the table how busy the other places were. Boom! The idea for Shnergle had begun - how useful would this be if it could be done simply on a mobile phone?
We often got asked "where does 'Shnergle' come from?" Well, it is simply a slang term used by the British Army for reconnaissance. So, it was fitting that as the co-founders were both ex British Army that this awesome app to help you decide what to do next (through reconnaissance) was named Shnergle.
Who was Shnergle?
So what happened?
We have published a detailed post mortem to our blog and a full life story can be seen on our Facebook page, but we basically found that we couldn't grow our userbase as fast as we needed to, either organically (unpaid) or paid (advertising). Without users, merchants (who loved the concept) didn't come onto the service, and without merchants the content required for users to value the service didn't flow; a classic chicken and egg scenario.
Whilst we could have thrown cash at the problem, it would have cost ridiculous amounts of money for a very uncertain commercial outcome, so we decided to not pursue further investment...
We still think the vision could be executable...
 We knew the odds of success were miniscule but we reached out anyway. Facebook declined, but we'd like to thank Mick Johnson for at least trying the app and responding!
Here is the code...


#include <GrTextureRect.h>
Public Member Functions | |
| GrTextureRect (const UPath &name, EFORMAT format, unsigned int width, unsigned int height) | |
| class GrTextureRect | |
| ~GrTextureRect () | |
| unsigned int | GetWidth () const |
| size info. | |
| unsigned int | GetHeight () const |
| void | BindToFramebuffer (unsigned int attachment) |
| binds to the actively selected framebuffer at the attachment passed in. | |
| void | UploadPixelData (int dstX, int dstY, int width, int height, const void *srcPels, GLenum srcFormat, GLenum srcType) |
| uploads data to the card. |
File: GrTextureRect.h Author: Kevin Bray Created: 04-12-06 Copyright © 2005 Bootstrap Studios project includes. class GrTextureRect
Definition at line 18 of file GrTextureRect.h.
| GrTextureRect::GrTextureRect | ( | const UPath & | name, | |
| EFORMAT | format, | |||
| unsigned int | width, | |||
| unsigned int | height | |||
| ) |
class GrTextureRect
ctor & dtor
create the texture object for the handle we've allocated.
Definition at line 51 of file GrTextureRect.cpp.
| GrTextureRect::~GrTextureRect | ( | ) |
Definition at line 61 of file GrTextureRect.cpp.
| void GrTextureRect::BindToFramebuffer | ( | unsigned int | attachment | ) |
binds to the actively selected framebuffer at the attachment passed in.
public methods.
Definition at line 73 of file GrTextureRect.cpp.
| unsigned int GrTextureRect::GetHeight | ( | ) | const [inline] |
Definition at line 26 of file GrTextureRect.h.
| unsigned int GrTextureRect::GetWidth | ( | ) | const [inline] |
| void GrTextureRect::UploadPixelData | ( | int | dstX, | |
| int | dstY, | |||
| int | width, | |||
| int | height, | |||
| const void * | srcPels, | |||
| GLenum | srcFormat, | |||
| GLenum | srcType | |||
| ) |
uploads data to the card.
currently, we do not support compressed textures! In the future, we need to either add another function to upload compressed data or compress the incoming data automatically on the fly (or both?).
bind to a texture unit and upload data.
Definition at line 84 of file GrTextureRect.cpp.


Spec
SwiftPatternPattern for SWIFT search, must be used together with SwiftFinder.
Pattern for SWIFT search, must be used together with SwiftFinder.
| Extends | Pattern |
|---|---|
| All Extended | Pattern |
| All Subcl's | SwiftLocalPattern, SwiftSemiGlobalPattern |
| Defined in | <seqan/index.h> |
| Signature |
template <typename TIndex, typename TSpec>
class Pattern<TIndex, Swift<TSpec> >;
|
Template Parameters
TSpec |
Specifies the type of Swift filter. |
|---|---|
TIndex |
A q-gram index of needle(s). Types: IndexQGram |
Interface Function Overview
-
TPosition beginPosition(pattern);
Returns the begin position of the local match in the pattern. -
TPosition endPosition(pattern);
Returns the end position of the local match in the pattern. -
TSize getMaxDeviationOfOrder(pattern);
Returns the maximal out-of-order distance of adjacent hits. -
TPair positionRange(pattern);
Returns a pair of the begin and end position in the haystack or needle for the last hit found. -
TPair positionRangeNoClip(pattern)
Returns a pair of the begin and end position in or beyond the haystack or needle for the last hit found. -
void setMinThreshold(pattern, seqNo, thresh);
Set minimal threshold (t) for a given needle.
Interface Functions Inherited From Pattern
Interface Metafunction Overview
Interface Metafunctions Inherited From Pattern
Member Variable Overview
-
SwiftParameters SwiftPattern::parameters
The SWIFT parameters to use for configuration.
Detailed Description
The Pattern must be a IndexQGram over multiple patterns. The allowed error rate must be given when find or windowFindBegin is called.
Provides a fast filter alogrithm that guarantees to find all regions overlapping with potential ε-matches. An ε-match is a matching region of minimal length and an error rate of at most ε.
See Also
Interface Functions Detail
TPosition beginPosition(pattern);
Returns the begin position of the local match in the pattern.
Parameters
pattern
|
The SwiftPattern to query. |
|---|
Returns
TPosition |
The SA value of the pattern text. |
|---|
Data Races
Thread safety unknown!
TPosition endPosition(pattern);
Returns the end position of the local match in the pattern.
Parameters
pattern
|
The SwiftPattern to query. |
|---|
Returns
TPosition |
The SA value of the pattern text. |
|---|
Data Races
Thread safety unknown!
TSize getMaxDeviationOfOrder(pattern);
Returns the maximal out-of-order distance of adjacent hits.
Parameters
pattern
|
A SwiftPattern. |
|---|
Returns
TSize |
Returns the maximal distance two adjacent hits can have which are not in increasing order. TSize is the size type of the underlying index. |
|---|
Data Races
Thread safety unknown!
TPair positionRange(pattern);
Returns a pair of the begin and end position in the haystack or needle for the last hit found.
Parameters
pattern
|
A Pattern object. |
|---|
Returns
TPair |
A Pair of the begin and end position in the haystack or needle for the last hit found. The return type is Pair<typename SAValue<THost&g;::Type> if THost is the type of haystack or needle. |
|---|
Data Races
Thread safety unknown!
See Also
TPair positionRangeNoClip(pattern)
Returns a pair of the begin and end position in or beyond the haystack or needle for the last hit found.
Parameters
pattern
|
SwiftPattern object to query. |
|---|
Returns
TPair |
A pair of the begin and end position in the haystack or needle for the last hit found. These positions could be negative or beyond the end of finder or pattern when using filter algorithms. The return type is Pair<typename SAValue<THost>::Type> if THost is the type of haystack or needle. |
|---|
Data Races
Thread safety unknown!
See Also
void setMinThreshold(pattern, seqNo, thresh);
Set minimal threshold (t) for a given needle.
Parameters
pattern
|
The SwiftPattern to modify. |
|---|---|
seqNo
|
The number to set the threshold for. |
tresh
|
The threshold to use. |
This function can be used to make the filter allow less errors for a given needle.
Data Races
Thread safety unknown!
Member Variables Detail
SwiftParameters SwiftPattern::parameters
The SWIFT parameters to use for configuration.


Bootcamp Buddies
Create a Group
Browse Groups
Sign Up
Log In
Messages
Calendar
Navbar Link
menu
My Profile
Willy
Name
Ruby, Python, Java, and whatever the latest newest language is
Languages
M
Gender
Very experienced programmer
Occupation
I love coding! Dogs. And coding. Karoke. Did I mention that I like coding?
Interests
Find Group Button
flash_on
Connect With Us
group
Invite Friends
settings
Help


{name} says:
{message}
You can make the following choices:
Posted On: {date} @ {time}
Name: {name} E-mail: {email} URL: {url} ISP Details: http://whois.arin.net/ui/query.do?q={ip} IP: {ip} Hostmask: {hostmask}
Powered By {cms_name}


Rift Post:
There are rules to the Rift of Dimension. Where you go and what goes on inside there remains a mystery. Once you get inside using the fragment, you'll only be able to stay for about 40 minutes before the dimension shifts. Don't forget that.
If you don't like where you entered, you can move just once.
This decision must be made by the party leader.
You may not leave the party or allow anyone else to join your party while there, it's too dangerous.
Return


Email or Phone
Password
from friends in News Feed.
in your life on your Timeline.
of what you're looking for with Facebook Search.
It's free and always will be.


|
Name
|
Type
|
Description
|
| dvsProf | ClusterComputeResourceDvsProfile[] |
Information related to network configuration. For each DvsProfile
object, specify either DvsProfile#dvsName or
DvsProfile#dvSwitch. Across all DvsProfile objects, specify
exactly one
DvsProfile.DVPortgroupSpecToServiceMapping#dvPortgroup or
DvsProfile.DVPortgroupSpecToServiceMapping#dvPortgroupSpec per
DvsProfile.DVPortgroupSpecToServiceMapping#service.
|
| hostConfigProfile | ClusterComputeResourceHostConfigurationProfile |
Configuration of host services and host settings.
|
| vcProf | ClusterComputeResourceVCProfile |
Describes cluster and EVC configuration.
|
| vSanConfigSpec | SDDCBase |
vSan configuration specification. This is vim.vsan.ReconfigSpec object
represented via the VIM object.
|
|
Properties inherited from DynamicData |
| None |


Building a custom modal, based on the following tutorial: https://scotch.io/tutorials/building-your-own-javascript-modal-plugin
I'm a modal window.


|
Deuersprech-Kompilierer
Der originale Deuersprech-Kompilierer
|
Öffentliche Methoden | |
| lalr_item_set () | |
| lalr_item_set (lalr_item_set other) throws internal_error | |
| Enumeration | all () |
| int | size () |
| boolean | contains (lalr_item itm) |
| lalr_item | find (lalr_item itm) |
| boolean | is_subset_of (lalr_item_set other) throws internal_error |
| boolean | is_superset_of (lalr_item_set other) throws internal_error |
| lalr_item | add (lalr_item itm) throws internal_error |
| void | remove (lalr_item itm) throws internal_error |
| void | add (lalr_item_set other) throws internal_error |
| void | remove (lalr_item_set other) throws internal_error |
| lalr_item | get_one () throws internal_error |
| void | compute_closure () throws internal_error |
| boolean | equals (lalr_item_set other) |
| boolean | equals (Object other) |
| int | hashCode () |
| String | toString () |
Geschützte Methoden | |
| void | not_null (Object obj) throws internal_error |
Geschützte Attribute | |
| Hashtable | _all = new Hashtable(11) |
| Integer | hashcode_cache = null |
This class represents a set of LALR items. For purposes of building these sets, items are considered unique only if they have unique cores (i.e., ignoring differences in their lookahead sets).
This class provides fairly conventional set oriented operations (union, sub/super-set tests, etc.), as well as an LALR "closure" operation (see compute_closure()).
|
inline |
Constructor for an empty set.
|
inline |
Constructor for cloning from another set.
| other | indicates set we should copy from. |
|
inline |
Add a singleton item, merging lookahead sets if the item is already part of the set. returns the element of the set that was added or merged into.
| itm | the item being added. |
|
inline |
Add a complete set, merging lookaheads where items are already in the set
| other | the set to be added. |
|
inline |
Access to all elements of the set.
|
inline |
Compute the closure of the set using the LALR closure rules. Basically for every item of the form:
[L ::= a *N alpha, l]
(where N is a a non terminal and alpha is a string of symbols) make sure there are also items of the form:
[N ::= *beta, first(alpha l)]
corresponding to each production of N. Items with identical cores but differing lookahead sets are merged by creating a new item with the same core and the union of the lookahead sets (the LA in LALR stands for "lookahead merged" and this is where the merger is). This routine assumes that nullability and first sets have been computed for all productions before it is called.
|
inline |
Does the set contain a particular item?
| itm | the item in question. |
|
inline |
Equality comparison.
|
inline |
Generic equality comparison.
Return the item in the set matching a particular item (or null if not found)
| itm | the item we are looking for. |
|
inline |
Remove and return one item from the set (done in hash order).
|
inline |
Return hash code.
|
inline |
Is this set an (improper) subset of another?
| other | the other set in question. |
|
inline |
Is this set an (improper) superset of another?
| other | the other set in question. |
|
inlineprotected |
Helper function for null test. Throws an interal_error exception if its parameter is null.
| obj | the object we are testing. |
|
inline |
Remove a single item if it is in the set.
| itm | the item to remove. |
|
inline |
Remove (set subtract) a complete set.
| other | the set to remove. |
|
inline |
Size of the set
|
inline |
Convert to string.
|
protected |
A hash table to implement the set. We store the items using themselves as keys.
|
protected |
Cached hashcode for this set.


--- layout: post title: Store Wars categories: [] tags: [] status: publish type: post published: true meta: _original_post_id: '' _original_import_author: John Duprey author: ---
jduprey
amused


| Type 55 WPM |
Open to Continuous Learning and Development |
| MS Office Suite - Word, Excel, PowerPoint |
Receptive to New Technologies |
| Verbal and Written Communication |
Tech-Savvy; PC and Mac Literate |
| Client and Customer Service |
Google Applications; i.e. Google Drive, gCal |
| Strong Work Ethics |
Bilingual; English and Spanish |
| Sensitive to Confidential Information |
Attention to Detail and Multi-tasking |


To order any of our delectable goods, see more menu options, or inquire about any of our services, please contact us directly:
Phone Number:<PHONE_NUMBER>
Email: ivylandsbakery@gmail.com


WITNESS LIST Public Education Committee February 10, 1999-2:00P Education Service Centers On: Robertson, Tommy (Self and Paradise Independent School District) Fast Growth School Coalition For: Berry, Rick (Self and Cypress-Fairbanks Independent School District) On: Casey, Daniel (Moak, Casey and Associates) Rural Schools For: Grusendorf, Bill (Texas Association of Rural Schools) Rural Schools Finance Coaltion On: Motheral, Mike (Self and Sundown Independent School District) School Finance On: Kauffman, Albert (MALDEF, Edgewood Plaintiffs) McInnis, John (Texas Association of School Boards) Rigg, Lynne (Texas School Alliance) Wisnoski, Joe (Texas Education Agency) On: Anderson, David (Texas Education Agency) Registering, but not testifying: Teacher Salaries On: Collier, Virginia (Texas Association of School Administrators)


Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
1. Introduction
1.1. About the CLI Guide
This guide is for engineers, consultants, and others who want to use the Migration Toolkit for Applications ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the CLI, review the generated reports, and take advantage of additional features.
1.2. About the Migration Toolkit for Applications
What is the Migration Toolkit for Applications?
The Migration Toolkit for Applications ({ProductShortName}) is an extensible and customizable rule-based tool that simplifies the migration and modernization of Java applications.
{ProductShortName} examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas needing changes. {ProductShortName} supports many migration paths including the following examples:
-
Upgrading to the latest release of Red Hat JBoss Enterprise Application Platform
-
Migrating from Oracle WebLogic or IBM WebSphere Application Server to Red Hat JBoss Enterprise Application Platform
-
Containerizing applications and making them cloud-ready
-
Migrating from Java Spring Boot to Quarkus
-
Updating from Oracle JDK to OpenJDK
For more information about use cases and migration paths, see the {ProductShortName} for developers web page.
How does the Migration Toolkit for Applications simplify migration?
The Migration Toolkit for Applications looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application.
{ProductShortName} generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects and to reduce the work involved.
How do I learn more?
See the Introduction to the Migration Toolkit for Applications to learn more about the features, supported configurations, system requirements, and available tools in the Migration Toolkit for Applications.
1.3. About the CLI
The CLI is a command-line tool in the Migration Toolkit for Applications that allows users to assess and prioritize migration and modernization efforts for applications. It provides numerous reports that highlight the analysis without the overhead of the other tools. The CLI includes a wide array of customization options, and allows you to finely tune {ProductShortName} analysis options or integrate with external automation tools.
2. Installing and Running the CLI
2.1. Installing the CLI
You can install the CLI on Linux, Windows, or macOS operating systems.
Prerequisites
-
Java Development Kit (JDK) installed. {ProductShortName} supports the following JDKs:
-
OpenJDK 1.8
-
OpenJDK 11
-
Oracle JDK 1.8
-
Oracle JDK 11
-
-
8 GB RAM
-
If you are installing on macOS, the value of
maxproc
must be2048
or greater.
-
Navigate to the {ProductShortName} Download page and download the
Migration Toolkit CLI
file. -
Extract the
.zip
file to a directory of your choice.NoteIf you are installing on a Windows operating system:
-
Extract the
.zip
file to a folder namedmta
to avoid aPath too long
error. -
If a Confirm file replace window is displayed during extraction, click Yes to all.
The installation directory is referred to as
<{ProductShortName}_HOME>
in this guide. -
2.2. Running the CLI
You can run {ProductShortName} against your application.
-
Open a terminal and navigate to the
<{ProductShortName}_HOME>/bin/
directory. -
Execute the
mta-cli
script, ormta-cli.bat
for Windows, and specify the appropriate arguments:$ ./mta-cli --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/output --source weblogic --target eap:6 \ --packages com.acme org.apache
-
--input
: The application to be evaluated. -
--output
: The output directory for the generated reports. -
--source
: The source technology for the application migration. -
--target
: The target technology for the application migration. -
--packages
: The packages to be evaluated. This argument is highly recommended to improve performance.
-
-
Access the report.
2.2.1. {ProductShortName} command examples
Running {ProductShortName} on an application archive
The following command analyzes the com.acme
and org.apache
packages of the jee-example-app-1.0.0.ear example EAR archive for migrating from JBoss EAP 5 to JBoss EAP 7:
$ <{ProductShortName}_HOME>/bin/mta-cli \
--input /path/to/jee-example-app-1.0.0.ear \
--output /path/to/report-output/ --source eap:5 --target eap:7 \
--packages com.acme org.apache
Running {ProductShortName} on source code
The following command analyzes the org.jboss.seam
packages of the seam-booking-5.2 example source code for migrating to JBoss EAP 6.
$ <{ProductShortName}_HOME>/bin/mta-cli --sourceMode --input /path/to/seam-booking-5.2/ \
--output /path/to/report-output/ --target eap:6 --packages org.jboss.seam
Running cloud-readiness rules
The following command analyzes the com.acme
and org.apache
packages of the jee-example-app-1.0.0.ear example EAR archive for migrating to JBoss EAP 7. It also evaluates for cloud readiness:
$ <{ProductShortName}_HOME>/bin/mta-cli --input /path/to/jee-example-app-1.0.0.ear \
--output /path/to/report-output/ \
--target eap:7 --target cloud-readiness --packages com.acme org.apache
Overriding {ProductShortName} properties
To override the default Fernflower decompiler, pass the -Dwindup.decompiler
argument on the command line. For example, to use the Procyon decompiler, use the following syntax:
$ <{ProductShortName}_HOME>/bin/mta-cli -Dwindup.decompiler=procyon --input \
<INPUT_ARCHIVE_OR_DIRECTORY> --output <OUTPUT_REPORT_DIRECTORY> \
--target <TARGET_TECHNOLOGY> --packages <PACKAGE_1> <PACKAGE_2>
2.2.2. Refactoring source code using OpenRewrite
OpenRewrite uses recipes to automate large-scale, distributed source code refactoring. It can be used with the {ProductShortName}.
The first OpenRewrite recipe, which is shipped with {ProductShortName} 5.2.1, renames imported javax
packages to their jakarta
equivalents.
You can use OpenRewrite in the {ProductShortName} CLI to prepare Java applications for migration.
-
Add the
openrewrite
argument when you execute the 'mta-cli' script and specify the other arguments appropriately:./mta-cli --openrewrite "-DactiveRecipes=<recipe name>" --input /path/to/source/project --goal dryRun
-
--openrewrite
: Flag specifying to run an OpenRewrite migration, instead of an {ProductShortName} analysis. -
"-DactiveRecipes=org.<recipe name>"
: The OpenRewrite recipe to apply to the input project.JavaxtoJakarta
is the default shipped recipe but you can add your own to the shippedrewrite.yml
and run that recipe instead. Therewrite.yml file
is located in therules/openrewrite/`
folder in the uncompressed {ProductShortName} distribution. -
--input
: The application to be evaluated. -
--goal
: Optional. The OpenRewrite maven goal to run. Parameters:-
dryRun
: The script returns a list of proposed changes, creates a patch file which can be applied later, and returns the following message:Run 'mvn rewrite:run' to apply the recipes.
-
run
: The script makes all changes automatically without listing them first.If you do not enter a parameter for
goal
, the script executes it asdryRun
.
-
-
-
To apply the recipe, run the command using the
run
parameter for the 'goal' argument:./mta-cli --openrewrite "-DactiveRecipes=<recipe name>" --input /path/to/source/project --goal run
|
Important
|
OpenRewrite recipe support is provided as Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. See Technology Preview features support scope on the Red Hat Customer Portal for information about the support scope for Technology Preview features. |
2.2.3. {ProductShortName} CLI Bash completion
The {ProductShortName} CLI provides an option to enable Bash completion for Linux systems, allowing the {ProductShortName} command-line arguments to be auto completed by pressing the Tab key when entering the commands. For instance, when Bash completion is enabled, entering the following displays a list of available arguments.
$ <{ProductShortName}_HOME>/bin/mta-cli [TAB]
Enabling Bash completion
To enable Bash completion for the current shell, execute the following command:
$ source <{ProductShortName}_HOME>/bash-completion/mta-cli
Enabling persistent Bash completion
The following commands allow Bash completion to persist across restarts:
-
To enable Bash completion for a specific user across system restarts, include the following line in that user’s
~/.bashrc
file.source <{ProductShortName}_HOME>/bash-completion/mta-cli
-
To enable Bash completion for all users across system restarts, copy the Migration Toolkit for Applications CLI Bash completion file to the
/etc/bash_completion.d/
directory as the root user.# cp <{ProductShortName}_HOME>/bash-completion/mta-cli /etc/bash_completion.d/
2.2.4. Accessing {ProductShortName} help
To see the complete list of available arguments for the mta-cli
command, open a terminal, navigate to the <{ProductShortName}_HOME>
directory, and execute the following command:
$ <{ProductShortName}_HOME>/bin/mta-cli --help
2.3. Accessing reports
When you run the Migration Toolkit for Applications, a report is generated in the <OUTPUT_REPORT_DIRECTORY>
that you specify using the --output
argument in the command line.
The output directory contains the following files and subdirectories:
<OUTPUT_REPORT_DIRECTORY>/ ├── index.html // Landing page for the report ├── <EXPORT_FILE>.csv // Optional export of data in CSV format ├── archives/ // Archives extracted from the application ├── mavenized/ // Optional Maven project structure ├── reports/ // Generated HTML reports ├── stats/ // Performance statistics
-
Obtain the path of the
index.html
file of your report from the output that appears after you run {ProductShortName}:Report created: <OUTPUT_REPORT_DIRECTORY>/index.html Access it at this URL: file:///<OUTPUT_REPORT_DIRECTORY>/index.html
-
Open the
index.html
file by using a browser.The generated report is displayed.
3. Reviewing the reports
The report examples shown in the following sections are a result of analyzing the com.acme
and org.apache
packages in the jee-example-app-1.0.0.ear example application, which is located in the {ProductShortName} GitHub source repository.
The report was generated using the following command.
$ <{ProductShortName}_HOME>/bin/mta-cli --input /home/username/mta-cli-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/mta-cli-reports/jee-example-app-1.0.0.ear-report --target eap:6 --packages com.acme org.apache
Use a browser to open the index.html
file located in the report output directory. This opens a landing page that lists the applications that were processed. Each row contains a high-level overview of the story points, number of incidents, and technologies encountered in that application.
|
Note
|
The incidents and estimated story points change as new rules are added to {ProductShortName}. The values here may not match what you see when you test this application. |
The following table lists all of the reports and pages that can be accessed from this main {ProductShortName} landing page. Click the name of the application, jee-example-app-1.0.0.ear, to view the application report.
| Page | How to Access |
|---|---|
Application |
Click the name of the application. |
Technologies report |
Click the Technologies link at the top of the page. |
Dependencies graph report |
Click the Dependencies Graph link at the top of the page. |
Archives shared by multiple applications |
Click the Archives shared by multiple applications link. Note that this link is only available when there are shared archives across multiple applications. |
Rule providers execution overview |
Click the Rule providers execution overview link at the bottom of the page. |
Used FreeMarker functions and directives |
Click the FreeMarker methods link at the bottom of the page. |
Send feedback form |
Click the Send Feedback link in the top navigation bar to open a form that allows you to submit feedback to the {ProductShortName} team. |
Note that if an application shares archives with other analyzed applications, you will see a breakdown of how many story points are from shared archives and how many are unique to this application.
Information about the archives that are shared among applications can be found in the Archives Shared by Multiple Applications reports.
3.1. Application report
3.1.1. Dashboard
Access this report from the report landing page by clicking on the application name in the Application List.
The dashboard gives an overview of the entire application migration effort. It summarizes:
-
The incidents and story points by category
-
The incidents and story points by level of effort of the suggested changes
-
The incidents by package
The top navigation bar lists the various reports that contain additional details about the migration of this application. Note that only those reports that are applicable to the current application will be available.
| Report | Description |
|---|---|
Issues |
Provides a concise summary of all issues that require attention. |
Application details |
Provides a detailed overview of all resources found within the application that may need attention during the migration. |
Technologies |
Displays all embedded libraries grouped by functionality, allowing you to quickly view the technologies used in each application. |
Dependencies graph |
Displays a graph of all Java-packaged dependencies found within the analyzed applications. This graph also demonstrates the relations of each dependency, allowing you to view nested and multiple dependencies. |
Dependencies |
Displays all Java-packaged dependencies found within the application. |
Unparsable |
Shows all files that {ProductShortName} could not parse in the expected format. For instance, a file with a |
Remote services |
Displays all remote services references that were found within the application. |
EJBs |
Contains a list of EJBs found within the application. |
JBPM |
Contains all of the JBPM-related resources that were discovered during analysis. |
JPA |
Contains details on all JPA-related resources that were found in the application. |
Hibernate |
Contains details on all Hibernate-related resources that were found in the application. |
Server resources |
Displays all server resources (for example, JNDI resources) in the input application. |
Spring Beans |
Contains a list of Spring Beans found during the analysis. |
Hard-coded IP addresses |
Provides a list of all hard-coded IP addresses that were found in the application. |
Ignored files |
Lists the files found in the application that, based on certain rules and {ProductShortName} configuration, were not processed. See the |
About |
Describes the current version of {ProductShortName} and provides helpful links for further assistance. |
3.1.2. Issues report
Access this report from the dashboard by clicking the Issues link.
This report includes details about every issue that was raised by the selected migration paths. The following information is provided for each issue encountered:
-
A title to summarize the issue.
-
The total number of incidents, or times the issue was encountered.
-
The rule story points to resolve a single instance of the issue.
-
The estimated level of effort to resolve the issue.
-
The total story points to resolve every instance encountered. This is calculated by multiplying the number of incidents found by the story points per incident.
Each reported issue may be expanded, by clicking on the title, to obtain additional details. The following information is provided.
-
A list of files where the incidents occurred, along with the number of incidents within each file. If the file is a Java source file, then clicking the filename will direct you to the corresponding Source report.
-
A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution.
-
A direct link, entitled Show Rule, to the rule that generated the issue.
Issues are sorted into four categories by default. Information on these categories is available at ask Category.
3.1.3. Application details report
Access this report from the dashboard by clicking the Application Details link.
The report lists the story points, the Java incidents by package, and a count of the occurrences of the technologies found in the application. Next is a display of application messages generated during the migration process. Finally, there is a breakdown of this information for each archive analyzed during the process.
Expand the jee-example-app-1.0.0.ear/jee-example-services.jar
to review the story points, Java incidents by package, and a count of the occurrences of the technologies found in this archive. This summary begins with a total of the story points assigned to its migration, followed by a table detailing the changes required for each file in the archive. The report contains the following columns.
| Column Name | Description |
|---|---|
Name |
The name of the file being analyzed. |
Technology |
The type of file being analyzed, for example, Decompiled Java File or Properties. |
Issues |
Warnings about areas of code that need review or changes. |
Story Points |
Level of effort required to migrate the file. |
Note that if an archive is duplicated several times in an application, it will be listed just once in the report and will be tagged with [Included multiple times]
.
The story points for archives that are duplicated within an application will be counted only once in the total story point count for that application.
3.1.4. Technologies report
Access this report from the dashboard by clicking the Technologies link.
The report lists the occurrences of technologies, grouped by function, in the analyzed application. It is an overview of the technologies found in the application, and is designed to assist users in quickly understanding each application’s purpose.
The image below shows the technologies used in the jee-example-app
.
3.1.5. Application dependencies graph report
The analyzed applications' dependencies are shown in this report, accessible from the Dependencies Graph link from the dashboard.
It includes a list of all WARs and JARs, including third-party JARs, and graphs the relations between each of the included files. Each circle in the graph represents a unique dependency defined in the application.
The below image shows the dependencies used in the jee-example-app
, with the selected application in the center of the graph.
The dependencies graph may be adjusted by using any of the following.
-
Clicking a dependency will display the name of the application in the upper-left corner. While selected the dependency will have a shaded circle identifying it, as seen on the center in the above image.
-
Clicking and dragging a circle will reposition it. Releasing the mouse will fix the dependency to the cursor’s location.
-
Clicking on a fixed dependency will release it, returning the dependency to its default distance from the application.
-
Double clicking anywhere will return the entire graph to the default state.
-
Clicking on any item in the legend will enable or disable all items of the selected type. For instance, selecting the embedded WARs icon will disable all embedded WARs if these are enabled, and will enable these dependencies if they are disabled.
3.1.6. Source report
The analysis of the jee-example-services.jar
lists the files in the JAR and the warnings and story points assigned to each one. Notice the com.acme.anvil.listener.AnvilWebLifecycleListener
file, at the time of this test, has 22 warnings and is assigned 16 story points. Click the file link to see the detail.
-
The Information section provides a summary of the story points.
-
This is followed by the file source code. Warnings appear in the file at the point where migration is required.
In this example, warnings appear at various import statements, declarations, and method calls. Each warning describes the issue and the action that should be taken.
3.2. Technologies report
Access this report from the report landing page by clicking the Technologies link.
This report provides an aggregate listing of the technologies used, grouped by function, for the analyzed applications. It shows how the technologies are distributed, and is typically reviewed after analyzing a large number of applications to group the applications and identify patterns. It also shows the size, number of libraries, and story point totals of each application.
Clicking any of the headers, such as Markup, sorts the results in descending order. Selecting the same header again will resort the results in ascending order. The currently selected header is identified in bold, next to a directional arrow, indicating the direction of the sort.
3.3. Dependencies graph report
Access this report from the report landing page by clicking the Dependencies Graph link.
It includes a list of all WARs and JARs, and graphs the relations between each of the included files. Each circle in the graph represents a unique dependency defined in the application. If a file is included as a dependency in multiple applications, these are linked in the graph.
In the below image we can see two distinct groups. On the left half we see a single WAR that defines several JARs as dependencies. On the right half we see the same dependencies used by multiple WARs, one of which is the selected overlord-commons-auth-2.0.11.Final.jar
.
The dependencies graph may be adjusted by using any of the following.
-
Clicking a dependency will display the name of the application in the upper-left corner. While selected the dependency will have a shaded circle identifying it, as seen on the center in the above image.
-
Clicking and dragging a circle will reposition it. Releasing the mouse will fix the dependency to the cursor’s location.
-
Clicking on a fixed dependency will release it, returning the dependency to its default distance from the application.
-
Double clicking anywhere will return the entire graph to the default state.
-
Clicking on any item in the legend will enable or disable all items of the selected type. For instance, selecting the embedded WARs icon will disable all embedded WARs if these are enabled, and will enable these dependencies if they are disabled.
3.4. Archives shared by multiple applications
Access these reports from the report landing page by clicking the Archives shared by multiple applications link. Note that this link is only available if there are applicable shared archives.
This allows you to view the detailed reports for all archives that are shared across multiple applications.
3.5. Rule providers execution overview
Access this report from the report landing page by clicking the Rule providers execution overview link.
This report provides the list of rules that executed when running the {ProductShortName} migration command against the application.
3.6. Used FreeMarker functions and directives
Access this report from the report landing page by clicking the FreeMarker methods link.
This report lists all the registered functions and directives that were used to build the report. It is useful for debugging purposes or if you plan to build your own custom report.
3.7. Send feedback form
Access this feedback form from the report landing page by clicking the Send feedback link.
This form allows you to rate the product, talk about what you like, and make suggestions for improvements.
4. Exporting the report in CSV format
{ProductShortName} provides the ability to export the report data, including the classifications and hints, to a flat file on your local file system. The export function currently supports the CSV file format, which presents the report data as fields separated by commas (,
).
The CSV file can be imported and manipulated by spreadsheet software such as Microsoft Excel, OpenOffice Calc, or LibreOffice Calc. Spreadsheet software provides the ability to sort, analyze, evaluate, and manage the result data from an {ProductShortName} report.
4.1. Exporting the report
To export the report as a CSV file, run {ProductShortName} with the --exportCSV
argument. A CSV file is created in the directory specified by the --output
argument for each application analyzed.
All discovered issues, spanning all the analyzed applications, are included in the AllIssues.csv
file that is exported to the root directory of the report.
Accessing the report from the application report
If you have exported the CSV report, you can download all of the CSV issues in the Issues Report. To download these issues, click Download All Issues CSV in the Issues Report.
4.2. Importing the CSV file into a spreadsheet program
-
Launch the spreadsheet software, for example, Microsoft Excel.
-
Choose File → Open.
-
Browse to the CSV exported file and select it.
-
The data is now ready to analyze in the spreadsheet software.
4.3. About the CSV data structure
The CSV formatted output file contains the following data fields:
- Rule Id
-
The ID of the rule that generated the given item.
- Problem type
-
hint or classification
- Title
-
The title of the classification or hint. This field summarizes the issue for the given item.
- Description
-
The detailed description of the issue for the given item.
- Links
-
URLs that provide additional information about the issue. A link consists of two attributes: the link and a description of the link.
- Application
-
The name of the application for which this item was generated.
- File Name
-
The name of the file for the given item.
- File Path
-
The file path for the given item.
- Line
-
The line number of the file for the given item.
- Story points
-
The number of story points, which represent the level of effort, assigned to the given item.
5. Mavenizing your application
{ProductShortName} provides the ability to generate an Apache Maven project structure based on the application provided. This will create a directory structure with the necessary Maven Project Object Model (POM) files that specify the appropriate dependencies.
Note that this feature is not intended to create a final solution for your project. It is meant to give you a starting point and identify the necessary dependencies and APIs for your application. Your project may require further customization.
5.1. Generating the Maven project structure
You can generate a Maven project structure for the provided application by passing in the --mavenize
flag when executing {ProductShortName}.
The following example runs {ProductShortName} using the jee-example-app-1.0.0.ear test application:
$ <{ProductShortName}_HOME>/bin/mta-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/output --target eap:6 --packages com.acme org.apache --mavenize
This generates the Maven project structure in the /path/to/output/mavenized
directory.
|
Note
|
You can only use the --mavenize option when providing a compiled application for the --input argument. This feature is not available when running {ProductShortName} against source code.
|
You can also use the --mavenizeGroupId
option to specify the <groupId>
to be used for the POM files. If unspecified, {ProductShortName} will attempt to identify an appropriate <groupId>
for the application, or will default to com.mycompany.mavenized
.
5.2. Reviewing the Maven project structure
The /path/to/output/mavenized/<APPLICATION_NAME>/
directory contains the following items:
-
A root
POM
file. This is thepom.xml
file at the top-level directory. -
A BOM file. This is the
POM
file in the directory ending with-bom
. -
One or more application
POM
files. Each module has itsPOM
file in a directory named after the archive.
The example jee-example-app-1.0.0.ear
application is an EAR archive that contains a WAR and several JARs. There is a separate directory created for each of these artifacts. Below is the Maven project structure created for this application.
/path/to/output/mavenized/jee-example-app/
jee-example-app-bom/pom.xml
jee-example-app-ear/pom.xml
jee-example-services2-jar/pom.xml
jee-example-services-jar/pom.xml
jee-example-web-war/pom.xml
pom.xml
Review each of the generated files and customize as appropriate for your project. To learn more about Maven POM files, see the Introduction to the POM section of the Apache Maven documentation.
Root POM file
The root POM file for the jee-example-app-1.0.0.ear
application can be found at /path/to/output/mavenized/jee-example-app/pom.xml
. This file identifies the directories for all of the project modules.
The following modules are listed in the root POM for the example jee-example-app-1.0.0.ear
application.
<modules>
<module>jee-example-app-bom</module>
<module>jee-example-services2-jar</module>
<module>jee-example-services-jar</module>
<module>jee-example-web-war</module>
<module>jee-example-app-ear</module>
</modules>
|
Note
|
Be sure to reorder the list of modules if necessary so that they are listed in an appropriate build order for your project. |
The root POM is also configured to use the Red Hat JBoss Enterprise Application Platform Maven repository to download project dependencies.
BOM file
The Bill of Materials (BOM) file is generated in the directory ending in -bom
. For the example jee-example-app-1.0.0.ear
application, the BOM file can be found at /path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml
. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the Introduction to the dependency mechanism section of the Apache Maven documentation.
The following dependencies are listed in the BOM for the example jee-example-app-1.0.0.ear
application
<dependencyManagement>
<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.6</version>
</dependency>
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.5</version>
</dependency>
</dependencies>
</dependencyManagement>
Application POM files
Each application module that can be mavenized has a separate directory containing its POM file. The directory name contains the name of the archive and ends in a -jar
, -war
, or -ear
suffix, depending on the archive type.
Each application POM file lists that module’s dependencies, including:
-
Third-party libraries
-
Java EE APIs
-
Application submodules
For example, the POM file for the jee-example-app-1.0.0.ear
EAR, /path/to/output/mavenized/jee-example-app/jee-example-app-ear/pom.xml
, lists the following dependencies.
<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.6</version>
</dependency>
<dependency>
<groupId>org.jboss.seam</groupId>
<artifactId>jee-example-web-war</artifactId>
<version>1.0</version>
<type>war</type>
</dependency>
<dependency>
<groupId>org.jboss.seam</groupId>
<artifactId>jee-example-services-jar</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>org.jboss.seam</groupId>
<artifactId>jee-example-services2-jar</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
6. Optimizing {ProductShortName} performance
{ProductShortName} performance depends on a number of factors, including hardware configuration, the number and types of files in the application, the size and number of applications to be evaluated, and whether the application contains source or compiled code. For example, a file that is larger than 10 MB may need a lot of time to process.
In general, {ProductShortName} spends about 40% of the time decompiling classes, 40% of the time executing rules, and the remainder of the time processing other tasks and generating reports. This section describes what you can do to improve the performance of {ProductShortName}.
6.1. Deploying and running the application
Try these suggestions first before upgrading hardware.
-
If possible, execute {ProductShortName} against the source code instead of the archives. This eliminates the need to decompile additional JARs and archives.
-
Specify a comma-separated list of the packages to be evaluated by {ProductShortName} using the
--packages
argument on the<{ProductShortName}_HOME>/bin/mta-cli
command line. If you omit this argument, {ProductShortName} will decompile everything, which has a big impact on performance. -
Specify the
--excludeTags
argument where possible to exclude them from processing. -
Avoid decompiling and analyzing any unnecessary packages and files, such as proprietary packages or included dependencies.
-
Increase your ulimit when analyzing large applications. See this Red Hat Knowledgebase article for instructions on how to do this for Red Hat Enterprise Linux.
-
If you have access to a server that has better resources than your laptop or desktop machine, you may want to consider running {ProductShortName} on that server.
6.2. Upgrading hardware
If the application and command-line suggestions above do not improve performance, you may need to upgrade your hardware.
-
If you have access to a server that has better resources than your laptop/desktop, then you may want to consider running {ProductShortName} on that server.
-
Very large applications that require decompilation have large memory requirements. 8 GB RAM is recommended. This allows 3 - 4 GB RAM for use by the JVM.
-
An upgrade from a single or dual-core to a quad-core CPU processor provides better performance.
-
Disk space and fragmentation can impact performance. A fast disk, especially a solid-state drive (SSD), with greater than 4 GB of defragmented disk space should improve performance.
6.3. Configuring {ProductShortName} to exclude packages and files
6.3.1. Excluding packages
You can exclude packages during decompilation and analysis to increase performance. References to these packages remain in the application’s source code but excluding them avoids the decompilation and analysis of proprietary classes.
Any packages that match the defined value are excluded. For example, you can use com.acme
to exclude both com.acme.example
and com.acme.roadrunner
.
You can exclude packages by either of the following methods:
-
Using the
--excludePackages
argument. -
Specifying the packages in a file contained within one of the ignored locations. Each package should be included on a separate line, and the file must end in
.package-ignore.txt
. For example, see<{ProductShortName}_HOME>/ignore/proprietary.package-ignore.txt
.
6.3.2. Excluding files
{ProductShortName} can exclude specific files, such as included libraries or dependencies, during scanning and report generation. Excluded files are defined in a file with the .{LC_PSN}-ignore.txt
or .windup-ignore.txt
extension within one of the ignored locations.
These files contain a regex string detailing the name to exclude, with one file listed per line. For example, you can exclude the library ant.jar
and any Java source files beginning with Example
with a file containing the following:
.*ant.jar .*Example.*\.java
6.3.3. Searching locations for exclusion
{ProductShortName} searches the following locations:
-
~/.mta/ignore/
-
~/.windup/ignore/
-
<{ProductShortName}_HOME>/ignore/
-
Any files and folders specified by the
--userIgnorePath
argument
Each of these files must conform to the rules specified for excluding packages or files, depending on the type of content to be excluded.
Appendix A: Reference material
A.1. About {ProductShortName} command-line arguments
The following is a detailed description of the available {ProductShortName} command line arguments.
|
Note
|
To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments:
|
| Argument | Description | ||
|---|---|---|---|
--additionalClassPath |
A space-delimited list of additional JAR files or directories to add to the class path so that they are available for decompilation or other analysis. |
||
--addonDir |
Add the specified directory as a custom add-on repository. |
||
--batchMode |
Flag to specify that {ProductShortName} should be run in a non-interactive mode without prompting for confirmation. This mode takes the default values for any parameters not passed in to the command line. |
||
--debug |
Flag to run {ProductShortName} in debug mode. |
||
--disableTattletale |
Flag to disable generation of the Tattletale report. If both |
||
--discoverPackages |
Flag to list all available packages in the input binary application. |
||
--enableClassNotFoundAnalysis |
Flag to enable analysis of Java files that are not available on the class path. This should not be used if some classes will be unavailable at analysis time. |
||
--enableCompatibleFilesReport |
Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications. |
||
--enableTattletale |
Flag to enable generation of a Tattletale report for each application. This option is enabled by default when |
||
--excludePackages |
A space-delimited list of packages to exclude from evaluation. For example, entering |
||
--excludeTags |
A space-delimited list of tags to exclude. When specified, rules with these tags will not be processed. To see the full list of tags, use the |
||
--explodedApp |
Flag to indicate that the provided input directory contains source files for a single application. |
||
--exportCSV |
Flag to export the report data to a CSV file on your local file system. {ProductShortName} creates the file in the directory specified by the |
||
--help |
Display the {ProductShortName} help message. |
||
--immutableAddonDir |
Add the specified directory as a custom read-only add-on repository. |
||
--includeTags |
A space-delimited list of tags to use. When specified, only rules with these tags will be processed. To see the full list of tags, use the |
||
--input |
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required. |
||
--install |
Specify add-ons to install. The syntax is |
||
--keepWorkDirs |
Flag to instruct {ProductShortName} to not delete temporary working files, such as the graph database and extracted archive files. This is useful for debugging purposes. |
||
--list |
Flag to list installed add-ons. |
||
--listSourceTechnologies |
Flag to list all available source technologies. |
||
--listTags |
Flag to list all available tags. |
||
--listTargetTechnologies |
Flag to list all available target technologies. |
||
--mavenize |
Flag to create a Maven project directory structure based on the structure and content of the application. This creates |
||
--mavenizeGroupId |
When used with the |
||
--online |
Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. |
||
--output |
Specify the path to the directory to output the report information generated by {ProductShortName}. |
||
--overwrite |
Flag to force delete the existing output directory specified by
|
||
--packages |
A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument. |
||
--remove |
Remove the specified add-ons. The syntax is |
||
--skipReports |
Flag to indicate that HTML reports should not be generated. A common use of this argument is when exporting report data to a CSV file using |
||
--source |
A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the |
||
--sourceMode |
Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. |
||
--target |
A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the |
||
--userIgnorePath |
Specify a location, in addition to |
||
--userLabelsDirectory |
Specify a location for {ProductShortName} to look for custom Target Runtime Labels. The value can be a directory containing label files or a single label file. The Target Runtime Label files must use either the |
||
--userRulesDirectory |
Specify a location, in addition to |
||
--version |
Display the {ProductShortName} version. |
A.1.1. Specifying the input
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
--input <INPUT_ARCHIVE_OR_DIRECTORY> [...]
Depending on whether the input file type provided to the --input
argument is a file or directory, it will be evaluated as follows depending on the additional arguments provided.
- Directory
-
--explodedApp --sourceMode Neither Argument The directory is evaluated as a single application.
The directory is evaluated as a single application.
Each subdirectory is evaluated as an application.
- File
-
--explodedApp --sourceMode Neither Argument Argument is ignored; the file is evaluated as a single application.
The file is evaluated as a compressed project.
The file is evaluated as a single application.
A.1.2. Specifying the output directory
Specify the path to the directory to output the report information generated by {ProductShortName}.
--output <OUTPUT_REPORT_DIRECTORY>
-
If omitted, the report will be generated in an
<INPUT_ARCHIVE_OR_DIRECTORY>.report
directory. -
If the output directory exists, you will be prompted with the following (with a default of N).
Overwrite all contents of "/home/username/<OUTPUT_REPORT_DIRECTORY>" (anything already in the directory will be deleted)? [y,N]
However, if you specify the --overwrite
argument, {ProductShortName} will proceed to delete and recreate the directory. See the description of this argument for more information.
A.1.3. Setting the source technology
A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the --target
argument, helps to determine which rulesets are used. Use the --listSourceTechnologies
argument to list all available sources.
--source <SOURCE_1> <SOURCE_2>
The --source
argument now provides version support, which follows the Maven version range syntax. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, --source eap:5
.
|
Warning
|
When migrating to JBoss EAP, be sure to specify the version, for example, See Supported migration paths in Introduction to the Migration Toolkit for Applications for the appropriate JBoss EAP version. |
A.1.4. Setting the target technology
A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the --source
argument, helps to determine which rulesets are used. If you do not specify this option, you are prompted to select a target. Use the --listTargetTechnologies
argument to list all available targets.
--target <TARGET_1> <TARGET_2>
The --target
argument now provides version support, which follows the Maven version range syntax. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, --target eap:7
.
|
Warning
|
When migrating to JBoss EAP, be sure to specify the version in the target, for example, See Supported migration paths in Introduction to the Migration Toolkit for Applications for the appropriate JBoss EAP version. |
A.1.5. Selecting packages
A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument.
--packages <PACKAGE_1> <PACKAGE_2> <PACKAGE_N>
-
In most cases, you are interested only in evaluating custom application class packages and not standard Java EE or third party packages. The
<PACKAGE_N>
argument is a package prefix; all subpackages will be scanned. For example, to scan the packagescom.mycustomapp
andcom.myotherapp
, use--packages com.mycustomapp com.myotherapp
argument on the command line. -
While you can provide package names for standard Java EE third party software like
org.apache
, it is usually best not to include them as they should not impact the migration effort.
|
Warning
|
If you omit the |
A.2. Supported technology tags
The following technology tags are supported in {ProductShortName} 5.2.1:
-
0MQ Client (embedded)
-
3scale (embedded)
-
Acegi Security (embedded)
-
AcrIS Security (embedded)
-
ActiveMQ (embedded)
-
Airframe (embedded)
-
Airlift Log Manager (embedded)
-
AKKA JTA (embedded)
-
Akka Testkit (embedded)
-
Amazon SQS Client (embedded)
-
AMQP Client (embedded)
-
Anakia (embedded)
-
AngularFaces (embedded)
-
ANTLR StringTemplate (embedded)
-
AOP Alliance (embedded)
-
Apache Accumulo Client
-
Apache Aries (embedded)
-
Apache Axis (embedded)
-
Apache Axis2 (embedded)
-
Apache Camel (embedded)
-
Apache Commons JCS (embedded)
-
Apache Commons Logging (embedded)
-
Apache Commons Validator (embedded)
-
Apache CXF (embedded)
-
Apache Flume (embedded)
-
Apache Geronimo (embedded)
-
Apache Hadoop (embedded)
-
Apache HBase Client
-
Apache Ignite (embedded)
-
Apache Karaf (embedded)
-
Apache Log4J (embedded)
-
Apache Mahout (embedded)
-
Apache Meecrowave JTA (embedded)
-
Apache Santuario (embedded)
-
Apache Shiro (embedded)
-
Apache Sirona JTA (embedded)
-
Apache Struts (embedded)
-
Apache Synapse (embedded)
-
Apache Tapestry (embedded)
-
Apache Wicket (embedded)
-
Apiman (embedded)
-
Arquillian (embedded)
-
AspectJ (embedded)
-
Atomikos JTA (embedded)
-
Avalon Logkit (embedded)
-
Axion Driver
-
BabbageFaces (embedded)
-
Bean Validation
-
BeanInject (embedded)
-
Blaze (embedded)
-
Blitz4j (embedded)
-
BootsFaces (embedded)
-
Bouncy Castle (embedded)
-
ButterFaces (embedded)
-
Cache API (embedded)
-
Cactus (embedded)
-
Camel Messaging Client (embedded)
-
Camunda (embedded)
-
Cassandra Client
-
CDI
-
CDI (embedded)
-
Cfg Engine (embedded)
-
Chunk Templates (embedded)
-
Cloudera (embedded)
-
Clustering EJB
-
Clustering Web Session
-
Coherence (embedded)
-
Common Annotations
-
Composite Logging JCL (embedded)
-
Concordion (embedded)
-
Cucumber (embedded)
-
Dagger (embedded)
-
DbUnit (embedded)
-
Debugging Support for Other Languages
-
Decompiled Java File
-
Demoiselle JTA (embedded)
-
Derby Driver
-
Drools (embedded)
-
DVSL (embedded)
-
Dynacache (embedded)
-
EAR
-
Easy Rules (embedded)
-
EasyMock (embedded)
-
EclipseLink (embedded)
-
EJB
-
EJB XML
-
Ehcache (embedded)
-
Elasticsearch (embedded)
-
Enterprise Web Services
-
Entity Bean
-
EtlUnit (embedded)
-
Everit JTA (embedded)
-
Evo JTA (embedded)
-
FreeMarker (embedded)
-
Geronimo JTA (embedded)
-
GFC Logging (embedded)
-
GIN (embedded)
-
GlassFish JTA (embedded)
-
Google Guice (embedded)
-
Grails (embedded)
-
Grapht DI (embedded)
-
Guava Testing (embedded)
-
GWT (embedded)
-
H2 Driver
-
Hamcrest (embedded)
-
Handlebars (embedded)
-
HavaRunner (embedded)
-
Hazelcast (embedded)
-
Hdiv (embedded)
-
Hibernate (embedded)
-
Hibernate Cfg
-
Hibernate Mapping
-
Hibernate OGM (embedded)
-
HighFaces (embedded)
-
HornetQ Client (embedded)
-
HSQLDB Driver
-
HTTP Client (embedded)
-
HttpUnit (embedded)
-
ICEfaces (embedded)
-
Ickenham (embedded)
-
Ignite JTA (embedded)
-
Ikasan (embedded)
-
iLog (embedded)
-
Infinispan (embedded)
-
Injekt for Kotlin (embedded)
-
Iroh (embedded)
-
Istio (embedded)
-
JACC
-
Jamon (embedded)
-
Jasypt (embedded)
-
Java EE
-
Java EE Batch
-
Java EE Batch API
-
Java EE JSON-P
-
Java EE Security
-
Java Source
-
Java Transaction API (embedded)
-
JavaMail
-
Javax Inject (embedded)
-
JAX-RPC
-
JAX-RS
-
JAX-WS
-
JAXB
-
JAXR
-
JayWire (embedded)
-
JBehave (embedded)
-
JBoss Cache (embedded)
-
JBoss EJB XML
-
JBoss logging (embedded)
-
JBoss Transactions (embedded)
-
JBoss Web XML
-
JBossMQ Client (embedded)
-
JBPM (embedded)
-
JCA
-
Jcabi Log (embedded)
-
JCache (embedded)
-
JCunit (embedded)
-
JDBC (embedded)
-
JDBC datasources
-
JDBC XA datasources
-
Jersey (embedded)
-
Jetbrick Template (embedded)
-
Jetty (embedded)
-
JFreeChart (embedded)
-
JFunk (embedded)
-
JMock (embedded)
-
JMockit (embedded)
-
JMS
-
JMS Connection Factory
-
JMS Queue
-
JMS Topic
-
JMustache (embedded)
-
JPA
-
JPA entities
-
JPA Matchers (embedded)
-
JPA named queries
-
JPA XML
-
JSecurity (embedded)
-
JSF (embedded)
-
JSF Page
-
JSilver (embedded)
-
JSON-B
-
JSP Page
-
JSTL (embedded)
-
JTA
-
Jukito (embedded)
-
JUnit (embedded)
-
Ka DI (embedded)
-
Keyczar (embedded)
-
Kibana (embedded)
-
KLogger (embedded)
-
Kodein (embedded)
-
Kotlin Logging (embedded)
-
KouInject (embedded)
-
KumuluzEE JTA (embedded)
-
LevelDB Client
-
Liferay (embedded)
-
LiferayFaces (embedded)
-
Lift JTA (embedded)
-
Log.io (embedded)
-
Log4s (embedded)
-
Logback (embedded)
-
Logging to file system
-
Logging to Socket Handler
-
Logging Utils (embedded)
-
Logstash (embedded)
-
Lumberjack (embedded)
-
Macros (embedded)
-
Manifest
-
MapR (embedded)
-
Maven XML
-
MckoiSQLDB Driver
-
MEJB
-
Memcached client (embedded)
-
Message (MDB)
-
Micro DI (embedded)
-
Microsoft SQL Driver
-
MinLog (embedded)
-
Mixer (embedded)
-
Mockito (embedded)
-
MongoDB Client
-
Monolog (embedded)
-
Morphia
-
MRules (embedded)
-
Mule (embedded)
-
Mule Functional Test Framework (embedded)
-
MultithreadedTC (embedded)
-
Mycontainer JTA (embedded)
-
MyFaces (embedded)
-
MySQL Driver
-
Narayana Arjuna (embedded)
-
Needle (embedded)
-
Neo4j (embedded)
-
NLOG4J (embedded)
-
Nuxeo JTA/JCA (embedded)
-
OACC (embedded)
-
OAUTH (embedded)
-
OCPsoft Logging Utils (embedded)
-
OmniFaces (embedded)
-
OpenFaces (embedded)
-
OpenPojo (embedded)
-
OpenSAML (embedded)
-
OpenWS (embedded)
-
OPS4J Pax Logging Service (embedded)
-
Oracle ADF (embedded)
-
Oracle DB Driver
-
Oracle Forms (embedded)
-
Orion EJB XML
-
Orion Web XML
-
Oscache (embedded)
-
OTR4J (embedded)
-
OW2 JTA (embedded)
-
OW2 Log Util (embedded)
-
OWASP CSRF Guard (embedded)
-
OWASP ESAPI (embedded)
-
Peaberry (embedded)
-
Pega (embedded)
-
Persistence units
-
Petals EIP (embedded)
-
PicketBox (embedded)
-
PicketLink (embedded)
-
PicoContainer (embedded)
-
Play (embedded)
-
Play Test (embedded)
-
Plexus Container (embedded)
-
Polyforms DI (embedded)
-
Portlet (embedded)
-
PostgreSQL Driver
-
PowerMock (embedded)
-
PrimeFaces (embedded)
-
Properties
-
Qpid Client (embedded)
-
RabbitMQ Client (embedded)
-
RandomizedTesting Runner (embedded)
-
Resource Adapter (embedded)
-
REST Assured (embedded)
-
Restito (embedded)
-
RichFaces (embedded)
-
RMI
-
RocketMQ Client (embedded)
-
Rythm Template Engine (embedded)
-
SAML (embedded)
-
Scalate (embedded)
-
Scaldi (embedded)
-
Scribe (embedded)
-
Seam (embedded)
-
ServiceMix (embedded)
-
Servlet
-
ShiftOne (embedded)
-
Silk DI (embedded)
-
SLF4J (embedded)
-
Snippetory Template Engine (embedded)
-
SNMP4J (embedded)
-
SOAP (SAAJ)
-
Spark (embedded)
-
Specsy (embedded)
-
Spock (embedded)
-
Spring (embedded)
-
Spring Batch (embedded)
-
Spring Boot (embedded)
-
Spring Data (embedded)
-
Spring Integration (embedded)
-
Spring Messaging Client (embedded)
-
Spring MVC (embedded)
-
Spring Security (embedded)
-
Spring Test (embedded)
-
Spring Transactions (embedded)
-
Spring XML
-
SQLite Driver
-
SSL (embedded)
-
Stateful (SFSB)
-
Stateless (SLSB)
-
Sticky Configured (embedded)
-
Stripes (embedded)
-
SubCut (embedded)
-
Swagger (embedded)
-
SwarmCache (embedded)
-
SwitchYard (embedded)
-
Syringe (embedded)
-
Talend ESB (embedded)
-
Teiid (embedded)
-
TensorFlow (embedded)
-
Test Interface (embedded)
-
TestNG (embedded)
-
Thymeleaf (embedded)
-
TieFaces (embedded)
-
tinylog (embedded)
-
Tomcat (embedded)
-
Tornado Inject (embedded)
-
Trimou (embedded)
-
Trunk JGuard (embedded)
-
Twirl (embedded)
-
Twitter Util Logging (embedded)
-
UberFire (embedded)
-
Unirest (embedded)
-
Unitils (embedded)
-
Vaadin (embedded)
-
Velocity (embedded)
-
Vlad (embedded)
-
Water Template Engine (embedded)
-
Web XML
-
WebLogic Web XML
-
Webmacro (embedded)
-
WebSphere EJB
-
WebSphere EJB Ext
-
WebSphere Web XML
-
WebSphere WS Binding
-
WebSphere WS Extension
-
Weka (embedded)
-
Weld (embedded)
-
WF Core JTA (embedded)
-
Winter (embedded)
-
WS Metadata
-
WSDL (embedded)
-
WSO2 (embedded)
-
WSS4J (embedded)
-
XACML (embedded)
-
XFire (embedded)
-
XMLUnit (embedded)
-
Zbus Client (embedded)
A.3. About rule story points
A.3.1. What are story points?
Story points are an abstract metric commonly used in Agile software development to estimate the level of effort needed to implement a feature or change.
The Migration Toolkit for Applications uses story points to express the level of effort needed to migrate particular application constructs, and the application as a whole. It does not necessarily translate to man-hours, but the value should be consistent across tasks.
A.3.2. How story points are estimated in rules
Estimating the level of effort for the story points for a rule can be tricky. The following are the general guidelines {ProductShortName} uses when estimating the level of effort required for a rule.
| Level of Effort | Story Points | Description |
|---|---|---|
Information |
0 |
An informational warning with very low or no priority for migration. |
Trivial |
1 |
The migration is a trivial change or a simple library swap with no or minimal API changes. |
Complex |
3 |
The changes required for the migration task are complex, but have a documented solution. |
Redesign |
5 |
The migration task requires a redesign or a complete library change, with significant API changes. |
Rearchitecture |
7 |
The migration requires a complete rearchitecture of the component or subsystem. |
Unknown |
13 |
The migration solution is not known and may need a complete rewrite. |
A.3.3. Task category
In addition to the level of effort, you can categorize migration tasks to indicate the severity of the task. The following categories are used to group issues to help prioritize the migration effort.
- Mandatory
-
The task must be completed for a successful migration. If the changes are not made, the resulting application will not build or run successfully. Examples include replacement of proprietary APIs that are not supported in the target platform.
- Optional
-
If the migration task is not completed, the application should work, but the results may not be optimal. If the change is not made at the time of migration, it is recommended to put it on the schedule soon after your migration is completed. An example of this would be the upgrade of EJB 2.x code to EJB 3.
- Potential
-
The task should be examined during the migration process, but there is not enough detailed information to determine if the task is mandatory for the migration to succeed. An example of this would be migrating a third-party proprietary type where there is no directly compatible type.
- Information
-
The task is included to inform you of the existence of certain files. These may need to be examined or modified as part of the modernization effort, but changes are typically not required. An example of this would be the presence of a logging dependency or a Maven
pom.xml
.
For more information on categorizing tasks, see Using custom rule categories.
A.4. Additional Resources
A.4.1. Getting involved
To help the Migration Toolkit for Applications cover most application constructs and server configurations, including yours, you can help with any of the following items.
-
Send an email to<EMAIL_ADDRESS>and let us know what {ProductShortName} migration rules should cover.
-
Provide example applications to test migration rules.
-
Identify application components and problem areas that may be difficult to migrate.
-
Write a short description of these problem migration areas.
-
Write a brief overview describing how to solve the problem migration areas.
-
-
Try Migration Toolkit for Applications on your application. Be sure to report any issues you encounter.
-
Contribute to the Migration Toolkit for Applications rules repository.
-
Write a Migration Toolkit for Applications rule to identify or automate a migration process.
-
Create a test for the new rule.
-
Details are provided in the Rules Development Guide.
-
-
Contribute to the project source code.
-
Create a core rule.
-
Improve {ProductShortName} performance or efficiency.
-
See the Core Development Guide for information about how to configure your environment and set up the project.
-
Any level of involvement is greatly appreciated!
A.4.2. Resources
-
{ProductShortName} forums: https://developer.jboss.org/en/windup
-
{ProductShortName} Jira issue trackers
-
Core {ProductShortName}: https://issues.redhat.com/projects/WINDUP
-
{ProductShortName} Rules: https://issues.redhat.com/projects/WINDUPRULE
-
-
{ProductShortName} mailing list<EMAIL_ADDRESS>-
{ProductShortName} IRC channel: Server FreeNode (
irc.freenode.net
), channel#windup
(transcripts).
A.4.3. Reporting issues
{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a Jira issue.
Revised on 2021-12-06 11:34:10 +0200


Handlebars.js
Remake uses Handlebars.js to render every template. All templates are server-rendered.
Template Variables
These are all the possible template variables you'll have access to in a Handlebars template:
- appName
- This is only relevant if you're deploying using Remake's deploy service. It's your unique app name.
- data
- This is only loaded on a page that's preceded by a username. so
/john
or/john/tasks
or/john/tasks/3456
. It will contain all the data that's in the database for the user that matches the username in the current route.
- This is only loaded on a page that's preceded by a username. so
- globalData
- This is static data shared by all templates and all users (loaded from the file
app/data/global-app-data.json
). It's useful for defining page names for global navigation items or static page titles you want to use for everyone.
- This is static data shared by all templates and all users (loaded from the file
- params
- These are the url parameters. For example, you can get the username, the pageName, the itemId from here.
- query
- This is an object with the all the query parameters in the url.
- pathname
- This is the current url's pathname.
- currentItem
- If you're at a route like
/john/tasks/3456
, this will be the item in john's data that matches the id3456
. If no item matching this id is found or you're not at that type of route, this variable will beundefined
.
- If you're at a route like
- parentItem
- This is the object that's above
currentItem
in the data. This is useful if you are letting the user browse their data hierarchically and you need to go up a level to the previous item.
- This is the object that's above
- flashErrors
- If there are any errors from the previous interaction (e.g. wrong password when signing in), they'll be stored in this array so they can be displayed on the page.
- flashSuccesses
- If there are any success messages from the previous interaction, they'll be stored in this array so they can be displayed on the page.
- currentUser
- This is an object with the current user's details in it. You can find their username like this:
currentUser.details.username
and their app data like this:currentUser.appData
.
- This is an object with the current user's details in it. You can find their username like this:
- pageAuthor
- This is available only if you're at route like
/john
or/kate
, with a username in it. If you are, this variable will contain the data of user that matches this username. It may be equal to the currentUser.
- This is available only if you're at route like
- isPageAuthor
- This is true if the currentUser is also the pageAuthor.
- pageHasAppData
- This is true if you're on a page like
/john
or/kate
. Data is loaded from their JSON file database, so it's available on this page. If there's apageAuthor
variable, this will be set totrue
.
- This is true if you're on a page like
Extra helpers
Remake also ships with all 188 Handlebars Helpers, so you can have lots of flexibility with how you render your data.
Custom #for loop
You may have noticed that the #for
loop we use in the tutorial video doesn't use a standard Handlebars block helpers syntax.
We did this for two reasons:
- We hook into this custom
#for
loop in order to make thedata-i-new
attribute work with it - We prefer
#for todo in todos
over something like#for todos item="todo"
(which would've been more standard).


Importing ratings is a great way to manage the rating process outside of Quepid, for example in your own custom application.
The CSV file should have the headers: 'Query Text', 'Doc ID', 'Rating'
Select CSV file to import:
{{ ctrl.csv.content }}


0%
//index.js contains the configuration variables.
Select an Event Link to Upload into Database
Event List Edit at:
https://docs.google.com/spreadsheets/d/1Yv06quH0qO16P_sdTMZ_hxtL1FVRD5svQbEoCkmF0SM/edit#gid=0
Event
Venue
Date