org.structr.web.entity.Indexable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structr-ui Show documentation

Structr is an open source framework based on the popular Neo4j graph database.

The newest version!

/**
 * Copyright (C) 2010-2016 Structr GmbH
 *
 * This file is part of Structr .
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Structr.  If not, see .
 */
package org.structr.web.entity;

import java.io.InputStream;
import org.structr.common.PropertyView;
import org.structr.core.Export;
import org.structr.core.GraphObject;
import org.structr.core.graph.NodeInterface;
import org.structr.core.graph.NodeService;
import org.structr.core.property.ArrayProperty;
import org.structr.core.property.Property;
import org.structr.core.property.StringProperty;

//~--- interfaces -------------------------------------------------------------

/**
 *
 *
 */
public interface Indexable extends NodeInterface {

	public static final Property contentType             = new StringProperty("contentType").indexedWhenEmpty();
	//public static final Property indexedContent          = new StringProperty("indexedContent");
	public static final Property extractedContent        = new StringProperty("extractedContent");
	public static final Property indexedWords          = new ArrayProperty("indexedWords", String.class).indexed(NodeService.NodeIndex.keyword);

	public static final org.structr.common.View uiView = new org.structr.common.View(Indexable.class, PropertyView.Ui, contentType, extractedContent, indexedWords);
	
	public InputStream getInputStream();

	@Export
	public GraphObject getSearchContext(final String searchTerm, final int contextLength);
	
}