| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_45) on Mon Apr 06 12:58:12 EDT 2015 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>PropertyMapper (Apache Chemistry OpenCMIS 0.13.0 API)</title> |
| <meta name="date" content="2015-04-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PropertyMapper (Apache Chemistry OpenCMIS 0.13.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertyMapper.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/MapperException.html" title="class in org.apache.chemistry.opencmis.tools.mapper"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapperExif.html" title="class in org.apache.chemistry.opencmis.tools.mapper"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html" target="_top">Frames</a></li> |
| <li><a href="PropertyMapper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.chemistry.opencmis.tools.mapper</div> |
| <h2 title="Interface PropertyMapper" class="title">Interface PropertyMapper</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/AbstractPropertyMapper.html" title="class in org.apache.chemistry.opencmis.tools.mapper">AbstractPropertyMapper</a>, <a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapperExif.html" title="class in org.apache.chemistry.opencmis.tools.mapper">PropertyMapperExif</a>, <a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapperTika.html" title="class in org.apache.chemistry.opencmis.tools.mapper">PropertyMapperTika</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">PropertyMapper</span></pre> |
| <div class="block">A property mapper is a class being responsible to map a Content-Type (e.g. image/jpeg) |
| to a CMIS type id and to map and convert properties. Extracted tags are mapped to |
| CMIS property ids and sometimes type conversion is required (e.g. a string to a date). |
| Classes implementing this interface are not responsible for extracting the metadata |
| (see MetadataParser). It only reads a configuration and maps properties. The |
| Configurator will read the configuration properties and instantiate implementations |
| of this interface (one instance per CMIS type)</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#convertValue(java.lang.String, org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition, java.lang.String)">convertValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/definitions/PropertyDefinition.html" title="interface in org.apache.chemistry.opencmis.commons.definitions">PropertyDefinition</a><?> propDef, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> strValue)</code> |
| <div class="block">Convert a value parsed from the file to the type the corresponding property expects</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#getContentTypes()">getContentTypes</a></strong>()</code> |
| <div class="block">get all content types handled by this parser</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#getMappedPropertyId(java.lang.String)">getMappedPropertyId</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">return the CMIS property id for a found tag in a file</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#getMappedTypeId()">getMappedTypeId</a></strong>()</code> |
| <div class="block">return the CMIS type id used for this mapper</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#initialize(java.lang.String, java.lang.String, java.util.Properties)">initialize</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cfgPrefix, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeKey, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code> |
| <div class="block">initialize a property mapper</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html#reset()">reset</a></strong>()</code> |
| <div class="block">Reset all internal data to get ready for a new parsing process</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize(java.lang.String, java.lang.String, java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>boolean initialize(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cfgPrefix, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeKey, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre> |
| <div class="block">initialize a property mapper</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfgPrefix</code> - prefix for all configuration entries in properties file</dd><dd><code>typeKey</code> - type key in configuration used to identify this type</dd><dd><code>properties</code> - all properties read from resource mapping.properties</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true, if processing should continue, false if not</dd></dl> |
| </li> |
| </ul> |
| <a name="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Reset all internal data to get ready for a new parsing process</div> |
| </li> |
| </ul> |
| <a name="getMappedTypeId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedTypeId</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMappedTypeId()</pre> |
| <div class="block">return the CMIS type id used for this mapper</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>CMIS type id to map this content type to or null if not mappable</dd></dl> |
| </li> |
| </ul> |
| <a name="getMappedPropertyId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedPropertyId</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMappedPropertyId(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">return the CMIS property id for a found tag in a file</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - tag (usually parsed from Tika) found in file</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>CMIS property this tag gets mapped to, null if not mapped</dd></dl> |
| </li> |
| </ul> |
| <a name="convertValue(java.lang.String, org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertValue</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> convertValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/definitions/PropertyDefinition.html" title="interface in org.apache.chemistry.opencmis.commons.definitions">PropertyDefinition</a><?> propDef, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> strValue)</pre> |
| <div class="block">Convert a value parsed from the file to the type the corresponding property expects</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - CMIS property id</dd><dd><code>propertyType</code> - property type from type definition</dd><dd><code>strValue</code> - value read from file (Tika always gives a string)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>converted value conforming to the mapped property</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getContentTypes</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getContentTypes()</pre> |
| <div class="block">get all content types handled by this parser</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>array with content types</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertyMapper.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/MapperException.html" title="class in org.apache.chemistry.opencmis.tools.mapper"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/tools/mapper/PropertyMapperExif.html" title="class in org.apache.chemistry.opencmis.tools.mapper"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/tools/mapper/PropertyMapper.html" target="_top">Frames</a></li> |
| <li><a href="PropertyMapper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2009-2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
