Java tutorial
/* Copyright (C) 2011 Peter Hanecak <hanecak@opendata.sk> * * This file is part of Open Data Node. * * Open Data Node 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 3 of the License, or * (at your option) any later version. * * Open Data Node 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 should have received a copy of the GNU General Public License * along with Open Data Node. If not, see <http://www.gnu.org/licenses/>. */ package sk.opendata.odn.repository.jackrabbit; import java.lang.reflect.InvocationTargetException; import java.util.Date; import org.apache.commons.beanutils.BeanUtils; import org.apache.commons.beanutils.PropertyUtils; import org.apache.commons.lang3.builder.CompareToBuilder; import org.apache.solr.client.solrj.beans.Field; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sk.opendata.odn.model.AbstractRecord; import sk.opendata.odn.model.Currency; import sk.opendata.odn.serialization.OdnSerializationException; /** * TODO: Update this stub copied from SolrItem * We're storing multiple harvested data sets in one SOLR index (see * http://wiki.apache.org/solr/MultipleIndexes for basic rationale why). * * To distinguish between data sets (and to allow searching only in * specific data set), field "type" is used. * * Theory of operation: * <ol> * <li>data are harvested, parsed, ... and stored in a relevant bean * {@code sk.opendata.odn.model.<Some>Record}</li> * <li>{@code SolrItem} is created from the "record bean" using * appropriate {@code SolrItem} constructor</li> * <li>"SOLR items" are collected in list and pushed to SOLR</li> * </ol> * * TODO: * Usage of {@code JackrabbitItemType} and {@code Currency} is causing exceptions like: * * Caused by: java.lang.RuntimeException: Exception while setting value : ORGANIZATION_RECORD on private sk.opendata.odn.repository.solr.JackrabbitItemType sk.opendata.odn.repository.solr.SolrItem.type * at org.apache.solr.client.solrj.beans.DocumentObjectBinder$DocField.set(DocumentObjectBinder.java:380) * at org.apache.solr.client.solrj.beans.DocumentObjectBinder$DocField.inject(DocumentObjectBinder.java:362) * at org.apache.solr.client.solrj.beans.DocumentObjectBinder.getBean(DocumentObjectBinder.java:67) * at org.apache.solr.client.solrj.beans.DocumentObjectBinder.getBeans(DocumentObjectBinder.java:47) * at org.apache.solr.client.solrj.response.QueryResponse.getBeans(QueryResponse.java:452) * at sk.opendata.odn.ui.panel.ResultPanel.doSearch(ResultPanel.java:147) * * so for now, we use {@code String} instead of those specialized types for following variables: * * 1) for {@code type}: instead of {@sk.opendata.odn.repository.solr.JackrabbitItemType} * * 2) for {@code currency}: instead of {@sk.opendata.odn.model.Currency} * * Hint: Maybe {@code @FieldObject} annotation in upcoming SOLR 3.6.0 will help. */ public class JackrabbitItem implements Comparable<JackrabbitItem> { private static Logger logger = LoggerFactory.getLogger(JackrabbitItem.class); // common fields: @Field private String id; @Field private String type; // TODO: Use 'JackrabbitItemType' - see TODO note in the class javadoc // "organization record" fields: should match what is available in // 'OrganizationRecord' and we need only those fields which are going to be // used in SOLR index // note: for now, to avoid changing schema, we're taking advantage of // dynamic field definitions. @Field private String name; @Field("legal_form") private String legalForm; @Field private String seat; @Field private String ico; @Field("date_from") private Date dateFrom; @Field("date_to") private Date dateTo; // "political party donation record" fields: should match what is available // in 'PoliticalPartyDonationRecord' and we need only those fields which are // going to be used in SOLR index // note: for now, to avoid changing schema, we're taking advantage of // dynamic field definitions. @Field("donor_name") private String donorName; @Field("donor_surname") private String donorSurname; //private String donorCompany; - we will map it to 'name' from OrganizationRecord as it is organization name too //private String donorIco; - we will map it to 'ico' from OrganizationRecord as it is ICO of organization too @Field("donation_value") private float donationValue; @Field private String currency; // TODO: Use 'Currency' - see TODO note in the class javadoc @Field("donor_address") private String donorAddress; @Field("donor_psc") private String donorPsc; // TODO: we use "string" in SOLR schema => make sure we use same form by filtering out spaces (i.e. to prevent cases like "058 01" and "05801" being considered different PSC) @Field("donor_city") private String donorCity; @Field("recipient_party") private String recipientParty; @Field("year") private String year; @Field("accept_date") private Date acceptDate; @Field("note") private String note; // "procurement record" fields: should match what is available in // 'ProcurementRecord' and we need only those fields which are going to be // used in SOLR index // note: for now, to avoid changing schema, we're taking advantage of // dynamic field definitions. //private String note; - same name as field in PoliticalPartyDonationRecord //private String year; - same name as field in PoliticalPartyDonationRecord @Field("bulletin_id") private String bulletinId; @Field("procurement_id") private String procurementId; @Field("procurement_subject") private String procurementSubject; @Field("price") private float price; //private Currency currency; - same name as field in PoliticalPartyDonationRecord @Field("vat_included") private boolean isVatIncluded; @Field("customer_ico") private String customerIco; @Field("supplier_ico") private String supplierIco; /** * Create SOLR item from given record. * * @param source * record - source of data * @param type * type of the record * @param id * ID of the record * * @return SOLR item created from given data * * @throws OdnSerializationException * when conversion into SOLR beans fails */ public static JackrabbitItem createJackrabbitItem(AbstractRecord source) throws OdnSerializationException { JackrabbitItem solrItem = null; try { solrItem = new JackrabbitItem(); PropertyUtils.copyProperties(solrItem, source); solrItem.type = JackrabbitItemType.getType(source.getClass()).toString(); solrItem.id = source.getId(); } catch (IllegalAccessException e) { logger.error("illegal access exception", e); throw new OdnSerializationException(e.getMessage(), e); } catch (InvocationTargetException e) { logger.error("invocation target exception", e); throw new OdnSerializationException(e.getMessage(), e); } catch (NoSuchMethodException e) { logger.error("no such method exception", e); throw new OdnSerializationException(e.getMessage(), e); } return solrItem; } public String toString() { try { return BeanUtils.describe(this).toString(); } catch (IllegalAccessException e) { logger.error("illegal access exception", e); } catch (InvocationTargetException e) { logger.error("invocation target exception", e); } catch (NoSuchMethodException e) { logger.error("no such method exception", e); } return super.toString(); } @Override public int compareTo(JackrabbitItem o) { return CompareToBuilder.reflectionCompare(this, o); } public String getId() { return id; } public void setId(String id) { this.id = id; } public JackrabbitItemType getType() { return JackrabbitItemType.valueOf(type); } public void setType(JackrabbitItemType type) { this.type = type.toString(); } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getLegalForm() { return legalForm; } public void setLegalForm(String legalForm) { this.legalForm = legalForm; } public String getSeat() { return seat; } public void setSeat(String seat) { this.seat = seat; } public String getIco() { return ico; } public void setIco(String ico) { this.ico = ico; } public Date getDateFrom() { return dateFrom; } public void setDateFrom(Date dateFrom) { this.dateFrom = dateFrom; } public Date getDateTo() { return dateTo; } public void setDateTo(Date dateTo) { this.dateTo = dateTo; } public String getDonorName() { return donorName; } public void setDonorName(String donorName) { this.donorName = donorName; } public String getDonorSurname() { return donorSurname; } public void setDonorSurname(String donorSurname) { this.donorSurname = donorSurname; } public float getDonationValue() { return donationValue; } public void setDonationValue(float donationValue) { this.donationValue = donationValue; } public String getDonorAddress() { return donorAddress; } public void setDonorAddress(String donorAddress) { this.donorAddress = donorAddress; } public String getDonorPsc() { return donorPsc; } public void setDonorPsc(String donorPsc) { this.donorPsc = donorPsc; } public String getDonorCity() { return donorCity; } public void setDonorCity(String donorCity) { this.donorCity = donorCity; } public String getRecipientParty() { return recipientParty; } public void setRecipientParty(String recipientParty) { this.recipientParty = recipientParty; } public String getYear() { return year; } public void setYear(String year) { this.year = year; } public Date getAcceptDate() { return acceptDate; } public void setAcceptDate(Date acceptDate) { this.acceptDate = acceptDate; } public String getNote() { return note; } public void setNote(String note) { this.note = note; } public String getBulletinId() { return bulletinId; } public void setBulletinId(String bulletinId) { this.bulletinId = bulletinId; } public String getProcurementId() { return procurementId; } public void setProcurementId(String procurementId) { this.procurementId = procurementId; } public String getProcurementSubject() { return procurementSubject; } public void setProcurementSubject(String procurementSubject) { this.procurementSubject = procurementSubject; } public float getPrice() { return price; } public void setPrice(float price) { this.price = price; } public Currency getCurrency() { if (currency == null) return null; return Currency.parse(currency); } public void setCurrency(Currency currency) { if (currency == null) this.currency = null; else this.currency = currency.toString(); } public boolean isVatIncluded() { return isVatIncluded; } public void setVatIncluded(boolean isVatIncluded) { this.isVatIncluded = isVatIncluded; } public String getCustomerIco() { return customerIco; } public void setCustomerIco(String customerIco) { this.customerIco = customerIco; } public String getSupplierIco() { return supplierIco; } public void setSupplierIco(String supplierIco) { this.supplierIco = supplierIco; } }