Skip to content

Commit

Permalink
formating and license
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsoika
rsoika committed Jan 6, 2020
1 parent 125d20e commit 7ba14bd
Show file tree
Hide file tree
Showing 8 changed files with 2,455 additions and 2,474 deletions.
911 changes: 454 additions & 457 deletions ...kflow-index-lucene/src/main/java/org/imixs/workflow/engine/lucene/LuceneIndexService.java
View file

Large diffs are not rendered by default.

219 changes: 115 additions & 104 deletions ...rkflow-index-lucene/src/main/java/org/imixs/workflow/engine/lucene/LuceneItemAdapter.java
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,39 @@
/*******************************************************************************
* <pre>
* Imixs Workflow
* Copyright (C) 2001-2020 Imixs Software Solutions GmbH,
* http://www.imixs.com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You can receive a copy of the GNU General Public
* License at http://www.gnu.org/licenses/gpl.html
*
* Project:
* https://www.imixs.org
* https://github.com/imixs/imixs-workflow
*
* Contributors:
* Imixs Software Solutions GmbH - initial API and implementation
* Ralph Soika - Software Developer
* </pre>
*******************************************************************************/

package org.imixs.workflow.engine.lucene;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.logging.Logger;

import javax.inject.Named;

import org.apache.lucene.document.Field.Store;
import org.apache.lucene.document.SortedDocValuesField;
import org.apache.lucene.document.StringField;
Expand All @@ -16,12 +43,10 @@
import org.imixs.workflow.engine.index.UpdateService;

/**
* The LuceneItemAdapter is a CDI bean, providing methods to convert the value
* of an Imixs Item into a IndexableField. This kind of lucene fields can be
* stored in a Lucene Document.
* The LuceneItemAdapter is a CDI bean, providing methods to convert the value of an Imixs Item into
* a IndexableField. This kind of lucene fields can be stored in a Lucene Document.
* <p>
* You can overwrite the bean to provide an alternative method of value
* conversion.
* You can overwrite the bean to provide an alternative method of value conversion.
*
* @see LuceneUdpateService#addItemValues
* @author rsoika
Expand All @@ -30,107 +55,93 @@
@Named
public class LuceneItemAdapter {

private static Logger logger = Logger.getLogger(UpdateService.class.getName());
private static Logger logger = Logger.getLogger(UpdateService.class.getName());

/**
* Creates a Indexable Lucene Field to be added into a Lucene document. The
* content of the itemValue will be converted. Depending on the parameter
* doAnalye a TextField or a StringField is created. The later is used for exact
* match.
* <p>
* The item value will not be stored into the lucene document
*
* @param itemName
* - name of the item will be used as the doc field name
* @param itemValue
* - the item value which will be converted by the method
* convertItemValue
* @param doAnalyze
* - if true the content will by analyzed by the LuceneAnalyzer
* configured in the IndexWriter
* @return
*/
public IndexableField adaptItemValue(String itemName, Object itemValue, boolean doAnalyze) {
return adaptItemValue(itemName, itemValue, doAnalyze, Store.NO);
}
/**
* Creates a Indexable Lucene Field to be added into a Lucene document. The content of the
* itemValue will be converted. Depending on the parameter doAnalye a TextField or a StringField
* is created. The later is used for exact match.
* <p>
* The item value will not be stored into the lucene document
*
* @param itemName - name of the item will be used as the doc field name
* @param itemValue - the item value which will be converted by the method convertItemValue
* @param doAnalyze - if true the content will by analyzed by the LuceneAnalyzer configured in the
* IndexWriter
* @return
*/
public IndexableField adaptItemValue(String itemName, Object itemValue, boolean doAnalyze) {
return adaptItemValue(itemName, itemValue, doAnalyze, Store.NO);
}

/**
* Creates a Indexable Lucene Field to be added into a Lucene document. The
* content of the itemValue will be converted. Depending on the parameter
* doAnalye a TextField or a StringField is created. The later is used for exact
* match.
* <p>
* The parameter 'store' indicates if Lucene should store the item value in the
* document
* <p>
* <code>Store.NO - Store.YES</code>
*
* @param itemName
* - name of the item will be used as the doc field name
* @param itemValue
* - the item value which will be converted by the method
* convertItemValue
* @param doAnalyze
* - if true the content will by analyzed by the LuceneAnalyzer
* configured in the IndexWriter
* @return
*/
public IndexableField adaptItemValue(String itemName, Object itemValue, boolean doAnalyze, Store stored) {
String stringValue = convertItemValue(itemValue);
logger.finest("......lucene add IndexField (analyzed=" + doAnalyze + "): " + itemName + "=" + stringValue);
if (doAnalyze) {
// just create a text field to be indexed
return new TextField(itemName, stringValue, stored);
} else {
// do not analyze content. Content can be used for exact match and sortable
// fields!
return new StringField(itemName, stringValue, stored);
}
}
/**
* Creates a Indexable Lucene Field to be added into a Lucene document. The content of the
* itemValue will be converted. Depending on the parameter doAnalye a TextField or a StringField
* is created. The later is used for exact match.
* <p>
* The parameter 'store' indicates if Lucene should store the item value in the document
* <p>
* <code>Store.NO - Store.YES</code>
*
* @param itemName - name of the item will be used as the doc field name
* @param itemValue - the item value which will be converted by the method convertItemValue
* @param doAnalyze - if true the content will by analyzed by the LuceneAnalyzer configured in the
* IndexWriter
* @return
*/
public IndexableField adaptItemValue(String itemName, Object itemValue, boolean doAnalyze,
Store stored) {
String stringValue = convertItemValue(itemValue);
logger.finest("......lucene add IndexField (analyzed=" + doAnalyze + "): " + itemName + "="
+ stringValue);
if (doAnalyze) {
// just create a text field to be indexed
return new TextField(itemName, stringValue, stored);
} else {
// do not analyze content. Content can be used for exact match and sortable
// fields!
return new StringField(itemName, stringValue, stored);
}
}

/**
* This method converts an ItemValue into a SortedDocValuesField.
*
* @param itemName
* - name of the item will be used as the doc field name
* @param itemValue
* - the item value which will be converted by the method
* convertItemValue
* @return SortedDocValuesField
*/
public SortedDocValuesField adaptSortableItemValue(String itemName, Object itemValue) {
String stringValue = convertItemValue(itemValue);
logger.finest("......lucene add sortable IndexValue: " + itemName + "=" + stringValue);
return new SortedDocValuesField(itemName, new BytesRef(stringValue));
}
/**
* This method converts an ItemValue into a SortedDocValuesField.
*
* @param itemName - name of the item will be used as the doc field name
* @param itemValue - the item value which will be converted by the method convertItemValue
* @return SortedDocValuesField
*/
public SortedDocValuesField adaptSortableItemValue(String itemName, Object itemValue) {
String stringValue = convertItemValue(itemValue);
logger.finest("......lucene add sortable IndexValue: " + itemName + "=" + stringValue);
return new SortedDocValuesField(itemName, new BytesRef(stringValue));
}

/**
* This method converts a ItemValue into a indexable text format. This method
* currently converts only Calendar and Date objects into a Luncene string
* representation of a date time value
*
* @param itemValue
* - object to be converted into a string
* @return string value
*/
public String convertItemValue(Object itemValue) {
String convertedValue = "";
/**
* This method converts a ItemValue into a indexable text format. This method currently converts
* only Calendar and Date objects into a Luncene string representation of a date time value
*
* @param itemValue - object to be converted into a string
* @return string value
*/
public String convertItemValue(Object itemValue) {
String convertedValue = "";

if (itemValue instanceof Calendar || itemValue instanceof Date) {
SimpleDateFormat dateformat = new SimpleDateFormat("yyyyMMddHHmmss");
if (itemValue instanceof Calendar || itemValue instanceof Date) {
SimpleDateFormat dateformat = new SimpleDateFormat("yyyyMMddHHmmss");

// convert calendar to lucene string representation
String sDateValue;
if (itemValue instanceof Calendar) {
sDateValue = dateformat.format(((Calendar) itemValue).getTime());
} else {
sDateValue = dateformat.format((Date) itemValue);
}
convertedValue = sDateValue;
} else {
// default
convertedValue = itemValue.toString();
}
return convertedValue;
}
// convert calendar to lucene string representation
String sDateValue;
if (itemValue instanceof Calendar) {
sDateValue = dateformat.format(((Calendar) itemValue).getTime());
} else {
sDateValue = dateformat.format((Date) itemValue);
}
convertedValue = sDateValue;
} else {
// default
convertedValue = itemValue.toString();
}
return convertedValue;
}
}
Loading

0 comments on commit 7ba14bd

Please sign in to comment.