grammarscope.browser

Class ControlDocumentView

java.lang.Object

grammarscope.queue.ServerLock

grammarscope.browser.Client

grammarscope.browser.Messenging

grammarscope.browser.Modeling

grammarscope.browser.ControlDocumentView

All Implemented Interfaces:

IServerListener, IEventListener

Direct Known Subclasses:

Browser

public abstract class ControlDocumentView
extends Modeling

ControlDocumentView

Author:

Bernard Bou

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	TEXT_VARIABLE
protected TypedDependencyMode	typedDependencyMode Typed Dependency mode
protected TypedDependencyProvider	typedDependencyProvider Typed Dependency provider
private static java.lang.String	URL_VARIABLE
private static java.lang.String	USE_URL_VARIABLE
protected static boolean	xmlCompatibilityMode XML compatibility mode

Fields inherited from class grammarscope.browser.Modeling

relationFilter, relationFilter2, relationModel, relationPalette

Fields inherited from class grammarscope.browser.Client

builder, clientProperties, loadServer, server, useNullServer

Constructor Summary

Constructors

Constructor and Description
ControlDocumentView() Constructor

Method Summary

Modifier and Type	Method and Description
(package private) abstract void	addView(View view) Add view
void	commandInput() Input document handler
void	commandOpen() Open command handler
void	commandOpenPaste() Paste document handler
void	commandOpenUrl() Open URL command handler
void	commandOpenXml(boolean dynamicRequest, boolean passURL, boolean passFile, boolean useServletUrl) Open XML document command handler
private static java.lang.String	encode(java.lang.String str) Encode encoded
protected void	endTask() Release input block
(package private) abstract java.lang.String[]	getArgs() Get command-line arguments
abstract java.util.List<Document>	getDocuments() Get documents
(package private) abstract java.util.Observable	getObservable() Get observable
(package private) abstract Settings	getSettings()
private java.lang.String	getTextFileUrl() Get text file url
java.lang.String	getUrl(Settings.Setting setting, boolean setProperty) Get Url
private java.lang.String	getXmlFileUrl() Get xml file url
protected void	initControlDocumentView() Initialize
Document	makeDocument(java.net.URL url) Load the document
private static Settings	makeSettings(Settings settings, java.lang.String[] args) Make settings allowing for overrides on command line
Document	makeTextDocument(java.lang.String text) Load the document
private static java.lang.String	makeUrl(java.lang.String url0, java.lang.String target, boolean targetIsUrl) Make Url
private View	makeView() Make view
private void	makeView(Document document, java.lang.String documentPath) Make view
static Document	makeXmlDocument(java.net.URL url) Load the document
void	notified(Event event) Event notification
protected void	onDone(Document document, boolean parsed, boolean analyzed) Document parsed/analyzed callback
protected void	onPublish(Document document, java.util.List<java.lang.Integer> sentenceIndices, boolean parsed, boolean analyzed) Document part published callback
void	startDocument(java.lang.String text) Start document input thread
void	startDocumentLoading(java.net.URL uRL) Start document loading thread
void	startProcessing(Document document, boolean recognize, boolean parse, boolean analyze, boolean clear, boolean waitServerReady) Start processing thread
protected void	startTask() Block input when task is initiated.
void	startXmlDocumentLoading(java.net.URL uRL) Start XML document loading thread

Methods inherited from class grammarscope.browser.Modeling

commandLoadRelationFilter, commandLoadRelationPalette, commandSaveRelationFilter, commandSaveRelationPalette, getFrame, initRelationModel, initRelationModel, makeRelationModel, setRelationModel

Methods inherited from class grammarscope.browser.Messenging

getFirer

Methods inherited from class grammarscope.browser.Client

bindToServer, checkCoreNlp, clearClient, initClient, onServerBound, setup, updateClient

Methods inherited from class grammarscope.queue.ServerLock

getState, lock, resetLock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xmlCompatibilityMode

protected static boolean xmlCompatibilityMode

XML compatibility mode

typedDependencyProvider

protected TypedDependencyProvider typedDependencyProvider

Typed Dependency provider

typedDependencyMode

protected TypedDependencyMode typedDependencyMode

Typed Dependency mode

USE_URL_VARIABLE

private static final java.lang.String USE_URL_VARIABLE

See Also:

Constant Field Values

URL_VARIABLE

private static final java.lang.String URL_VARIABLE

See Also:

Constant Field Values

TEXT_VARIABLE

private static final java.lang.String TEXT_VARIABLE

See Also:

Constant Field Values

Constructor Detail

ControlDocumentView

public ControlDocumentView()

Constructor

Method Detail

initControlDocumentView

protected void initControlDocumentView()

Initialize

makeSettings

private static Settings makeSettings(Settings settings,
                                     java.lang.String[] args)

Make settings allowing for overrides on command line

Parameters:

settings - settings

args - command-line arguments

Returns:

settings (properties)

notified

public void notified(Event event)

Description copied from interface: IEventListener

Event notification

Specified by:

notified in interface IEventListener

Overrides:

notified in class Modeling

Parameters:

event - event

getSettings

abstract Settings getSettings()

Specified by:

getSettings in class Modeling

getArgs

abstract java.lang.String[] getArgs()

Get command-line arguments

Returns:

arguments

getObservable

abstract java.util.Observable getObservable()

Get observable

Returns:

observable

getDocuments

public abstract java.util.List<Document> getDocuments()

Get documents

Returns:

documents

addView

abstract void addView(View view)

Add view

Parameters:

view - view

makeView

private View makeView()

Make view

Returns:

view

makeView

private void makeView(Document document,
                      java.lang.String documentPath)

Make view

Parameters:

document - document

documentPath - document path

makeDocument

public Document makeDocument(java.net.URL url)

Load the document

Parameters:

url - url to the document

Returns:

document

makeXmlDocument

public static Document makeXmlDocument(java.net.URL url)

Load the document

Parameters:

url - url to the document

Returns:

document

makeTextDocument

public Document makeTextDocument(java.lang.String text)

Load the document

Parameters:

text - text

Returns:

document

startDocumentLoading

public void startDocumentLoading(java.net.URL uRL)

Start document loading thread

Parameters:

uRL - url to the document

startDocument

public void startDocument(java.lang.String text)

Start document input thread

Parameters:

text - text

startXmlDocumentLoading

public void startXmlDocumentLoading(java.net.URL uRL)

Start XML document loading thread

Parameters:

uRL - url to the document

startTask

protected void startTask()

Block input when task is initiated.

endTask

protected void endTask()

Release input block

startProcessing

public void startProcessing(Document document,
                            boolean recognize,
                            boolean parse,
                            boolean analyze,
                            boolean clear,
                            boolean waitServerReady)

Start processing thread

Parameters:

document - document

recognize - recognize (pos, named entities)

parse - parse

analyze - analyze

clear - clear cached data

waitServerReady - wait until server is ready

onDone

protected void onDone(Document document,
                      boolean parsed,
                      boolean analyzed)

Document parsed/analyzed callback

Parameters:

document - document

parsed - parsed

analyzed - analyzed

onPublish

protected void onPublish(Document document,
                         java.util.List<java.lang.Integer> sentenceIndices,
                         boolean parsed,
                         boolean analyzed)

Document part published callback

Parameters:

document - document

sentenceIndices - indices of done sentences (-1=all done)

parsed - parsed

analyzed - analyzed

commandOpen

public void commandOpen()

Open command handler

commandOpenUrl

public void commandOpenUrl()

Open URL command handler

commandOpenPaste

public void commandOpenPaste()

Paste document handler

commandInput

public void commandInput()

Input document handler

commandOpenXml

public void commandOpenXml(boolean dynamicRequest,
                           boolean passURL,
                           boolean passFile,
                           boolean useServletUrl)

Open XML document command handler

Parameters:

dynamicRequest - true if dynamic request

passURL - whether to pass url

passFile - whether to pass file

useServletUrl - whether to use servlet url

makeUrl

private static java.lang.String makeUrl(java.lang.String url0,
                                        java.lang.String target,
                                        boolean targetIsUrl)

Make Url

Parameters:

url0 - url

target - target

targetIsUrl - whether url (true) or text (false) has been passed as target

Returns:

url

getUrl

public java.lang.String getUrl(Settings.Setting setting,
                               boolean setProperty)

Get Url

Parameters:

setting - setting

setProperty - whether to se property

Returns:

Url string

getXmlFileUrl

private java.lang.String getXmlFileUrl()

Get xml file url

Returns:

Url string

getTextFileUrl

private java.lang.String getTextFileUrl()

Get text file url

Returns:

Url string

encode

private static java.lang.String encode(java.lang.String str)

Encode encoded

Parameters:

str - string

Returns:

encoded string