| 1 | /******************************************************************************* | 
| 2 |  * Copyright (c) 2009 IBM Corporation and others. | 
| 3 |  * All rights reserved. This program and the accompanying materials | 
| 4 |  * are made available under the terms of the Eclipse Public License v1.0 | 
| 5 |  * which accompanies this distribution, and is available at | 
| 6 |  * http://www.eclipse.org/legal/epl-v10.html | 
| 7 |  * | 
| 8 |  * Contributors: | 
| 9 |  *     IBM Corporation - initial API and implementation | 
| 10 |  *******************************************************************************/ | 
| 11 | package org.eclipse.pde.api.tools.internal.search; | 
| 12 |   | 
| 13 | import org.eclipse.jdt.core.Signature; | 
| 14 | import org.eclipse.osgi.util.NLS; | 
| 15 |   | 
| 16 | /** | 
| 17 |  * Report converter specialization for migration reports | 
| 18 |  *  | 
| 19 |  * @since 1.0.1 | 
| 20 |  */ | 
| 21 | public class MigrationReportConvertor extends UseReportConverter { | 
| 22 |   | 
| 23 |         /** | 
| 24 |          * Constructor | 
| 25 |          * @param htmlroot | 
| 26 |          * @param xmlroot | 
| 27 |          * @param patterns | 
| 28 |          */ | 
| 29 |         public MigrationReportConvertor(String htmlroot, String xmlroot, String[] patterns) { | 
| 30 |                 super(htmlroot, xmlroot, patterns); | 
| 31 |         } | 
| 32 |   | 
| 33 |         /* (non-Javadoc) | 
| 34 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getIndexTitle() | 
| 35 |          */ | 
| 36 |         protected String getIndexTitle() { | 
| 37 |                 return SearchMessages.MigrationReportConvertor_bundle_migration_information; | 
| 38 |         } | 
| 39 |          | 
| 40 |         /* (non-Javadoc) | 
| 41 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getIndexHeader() | 
| 42 |          */ | 
| 43 |         protected String getIndexHeader() { | 
| 44 |                 return getIndexTitle(); | 
| 45 |         } | 
| 46 |          | 
| 47 |         /* (non-Javadoc) | 
| 48 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getReferencedTypeTitle(java.lang.String) | 
| 49 |          */ | 
| 50 |         protected String getReferencedTypeTitle(String bundle) { | 
| 51 |                 return NLS.bind(SearchMessages.MigrationReportConvertor_type_with_unresolved_refs, bundle); | 
| 52 |         } | 
| 53 |          | 
| 54 |         /* (non-Javadoc) | 
| 55 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getReferencedTypeHeader(java.lang.String) | 
| 56 |          */ | 
| 57 |         protected String getReferencedTypeHeader(String bundle) { | 
| 58 |                 return getReferencedTypeTitle(bundle); | 
| 59 |         } | 
| 60 |          | 
| 61 |         /* (non-Javadoc) | 
| 62 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getAdditionalReferencedTypeInformation() | 
| 63 |          */ | 
| 64 |         protected String getAdditionalReferencedTypeInformation() { | 
| 65 |                 return SearchMessages.MigrationReportConvertor_table_shows_unresolved; | 
| 66 |         } | 
| 67 |          | 
| 68 |         /* (non-Javadoc) | 
| 69 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getTypeTitle(java.lang.String) | 
| 70 |          */ | 
| 71 |         protected String getTypeTitle(String typename) { | 
| 72 |                 return NLS.bind(SearchMessages.MigrationReportConvertor_type_migration_information, Signature.getSimpleName(typename)); | 
| 73 |         } | 
| 74 |          | 
| 75 |         /* (non-Javadoc) | 
| 76 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getTypeHeader(java.lang.String) | 
| 77 |          */ | 
| 78 |         protected String getTypeHeader(String typename) { | 
| 79 |                 return getTypeTitle(typename); | 
| 80 |         } | 
| 81 |          | 
| 82 |         /* (non-Javadoc) | 
| 83 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getTypeDetailsHeader() | 
| 84 |          */ | 
| 85 |         protected String getTypeDetailsHeader() { | 
| 86 |                 return SearchMessages.MigrationReportConvertor_migration_details; | 
| 87 |         } | 
| 88 |          | 
| 89 |         /* (non-Javadoc) | 
| 90 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getTypeDetails() | 
| 91 |          */ | 
| 92 |         protected String getTypeDetails() { | 
| 93 |                 return SearchMessages.MigrationReportConvertor_click_table_entry; | 
| 94 |         } | 
| 95 |          | 
| 96 |         /* (non-Javadoc) | 
| 97 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getTypeCountSummary(java.lang.String, org.eclipse.pde.api.tools.internal.search.UseReportConverter.CountGroup, int) | 
| 98 |          */ | 
| 99 |         protected String getTypeCountSummary(String typename, CountGroup counts, int membercount) { | 
| 100 |                 StringBuffer buffer = new StringBuffer(); | 
| 101 |                 buffer.append(OPEN_H4).append(SearchMessages.UseReportConverter_summary).append(CLOSE_H4);  | 
| 102 |                 buffer.append(OPEN_P).append(NLS.bind(SearchMessages.MigrationReportConvertor_member_has_unresolved_refs, new String[] {typename, Integer.toString(counts.getTotalRefCount()), Integer.toString(membercount)})).append(CLOSE_P);   | 
| 103 |                 return buffer.toString(); | 
| 104 |         } | 
| 105 |          | 
| 106 |         /* (non-Javadoc) | 
| 107 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getAdditionalIndexInfo(boolean) | 
| 108 |          */ | 
| 109 |         protected String getAdditionalIndexInfo(boolean hasreports) { | 
| 110 |                 if(hasreports) { | 
| 111 |                         StringBuffer buffer = new StringBuffer(); | 
| 112 |                         buffer.append(SearchMessages.MigrationReportConvertor_bundles_have_references); | 
| 113 |                         return buffer.toString(); | 
| 114 |                 } | 
| 115 |                 return null; | 
| 116 |         } | 
| 117 |          | 
| 118 |         /* (non-Javadoc) | 
| 119 |          * @see org.eclipse.pde.api.tools.internal.search.UseReportConverter#getNoReportsInformation() | 
| 120 |          */ | 
| 121 |         protected String getNoReportsInformation() { | 
| 122 |                 StringBuffer buffer = new StringBuffer(); | 
| 123 |                 buffer.append(OPEN_P).append(BR).append(SearchMessages.MigrationReportConvertor_no_reported_migration_problems).append(CLOSE_P);  | 
| 124 |                 return buffer.toString(); | 
| 125 |         } | 
| 126 | } |